| Name | gradio-highlightcode JSON |
| Version |
0.0.9
JSON |
| download |
| home_page | None |
| Summary | Inference from: https://pypi.org/project/gradio-highlightedcode/ Update Custom Package to the Latest Gradio Code (Support for C, C++...) and optimized invocation methods. |
| upload_time | 2024-07-14 07:07:35 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
gradio-custom-component
gradio-template-code
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `gradio_highlightcode`
<a href="https://pypi.org/project/gradio_highlightcode/" target="_blank"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/gradio_highlightcode"></a>
Inference from: https://pypi.org/project/gradio-highlightedcode/
Update Custom Package to the Latest Gradio Code (Support for C, C++...) and optimized invocation methods.
## Installation
```bash
pip install gradio_highlightcode
```
## Usage
```python
import gradio as gr
from gradio_highlightcode import highlightcode
import time
example = highlightcode().example_value()
initial_value = """
#include <stdio.h>
int main() {
printf("Hello, World!\n");
return 0;
}
"""
with gr.Blocks() as demo:
code = highlightcode(initial_value, language="c", highlights=[(3, 6, "rgb(255 254 213)")])
if __name__ == "__main__":
demo.launch()
```
## `highlightcode`
### Initialization
<table>
<thead>
<tr>
<th align="left">name</th>
<th align="left" style="width: 25%;">type</th>
<th align="left">default</th>
<th align="left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>value</code></td>
<td align="left" style="width: 25%;">
```python
str | Callable | tuple[str] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Default value to show in the code editor. If callable, the function will be called whenever the app loads to set the initial value of the component.</td>
</tr>
<tr>
<td align="left"><code>language</code></td>
<td align="left" style="width: 25%;">
```python
Literal[
"python",
"c",
"cpp",
"markdown",
"json",
"html",
"css",
"javascript",
"typescript",
"yaml",
"dockerfile",
"shell",
"r",
"sql",
"sql-msSQL",
"sql-mySQL",
"sql-mariaDB",
"sql-sqlite",
"sql-cassandra",
"sql-plSQL",
"sql-hive",
"sql-pgSQL",
"sql-gql",
"sql-gpSQL",
"sql-sparkSQL",
"sql-esper",
]
| None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">The language to display the code as. Supported languages listed in `gr.Code.languages`.</td>
</tr>
<tr>
<td align="left"><code>highlights</code></td>
<td align="left" style="width: 25%;">
```python
list[tuple[int, int, str]] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Specifies the lines to highlight. Use the first number for the starting line, the second for the ending line, and the last parameter for the color.</td>
</tr>
<tr>
<td align="left"><code>every</code></td>
<td align="left" style="width: 25%;">
```python
Timer | float | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.</td>
</tr>
<tr>
<td align="left"><code>inputs</code></td>
<td align="left" style="width: 25%;">
```python
Component | list[Component] | set[Component] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.</td>
</tr>
<tr>
<td align="left"><code>lines</code></td>
<td align="left" style="width: 25%;">
```python
int
```
</td>
<td align="left"><code>5</code></td>
<td align="left">None</td>
</tr>
<tr>
<td align="left"><code>label</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.</td>
</tr>
<tr>
<td align="left"><code>interactive</code></td>
<td align="left" style="width: 25%;">
```python
bool | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Whether user should be able to enter code or only view it.</td>
</tr>
<tr>
<td align="left"><code>show_label</code></td>
<td align="left" style="width: 25%;">
```python
bool | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">if True, will display label.</td>
</tr>
<tr>
<td align="left"><code>container</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If True, will place the component in a container - providing some extra padding around the border.</td>
</tr>
<tr>
<td align="left"><code>scale</code></td>
<td align="left" style="width: 25%;">
```python
int | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.</td>
</tr>
<tr>
<td align="left"><code>min_width</code></td>
<td align="left" style="width: 25%;">
```python
int
```
</td>
<td align="left"><code>160</code></td>
<td align="left">minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.</td>
</tr>
<tr>
<td align="left"><code>visible</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If False, component will be hidden.</td>
</tr>
<tr>
<td align="left"><code>elem_id</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.</td>
</tr>
<tr>
<td align="left"><code>elem_classes</code></td>
<td align="left" style="width: 25%;">
```python
list[str] | str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.</td>
</tr>
<tr>
<td align="left"><code>render</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.</td>
</tr>
<tr>
<td align="left"><code>key</code></td>
<td align="left" style="width: 25%;">
```python
int | str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.</td>
</tr>
</tbody></table>
### Events
| name | description |
|:-----|:------------|
| `change` | Triggered when the value of the highlightcode changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See `.input()` for a listener that is only triggered by user input. |
| `input` | This listener is triggered when the user changes the value of the highlightcode. |
| `focus` | This listener is triggered when the highlightcode is focused. |
| `blur` | This listener is triggered when the highlightcode is unfocused/blurred. |
### User function
The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).
- When used as an Input, the component only impacts the input signature of the user function.
- When used as an output, the component only impacts the return signature of the user function.
The code snippet below is accurate in cases where the component is used as both an input and an output.
- **As output:** Is passed, passes the code entered as a `str`.
- **As input:** Should return, expects a `str` of code or a single-element `tuple`: (filepath,) with the `str` path to a file containing the code.
```python
def predict(
value: str | None
) -> tuple[str] | str | None:
return value
```
Raw data
{
"_id": null,
"home_page": null,
"name": "gradio-highlightcode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "gradio-custom-component, gradio-template-Code",
"author": null,
"author_email": "Nseven <a0939660914@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a0/97/df3c90dc019757b88a8825b7fbe53b856f4639c2b0f0a3ae0cb8bea77a86/gradio_highlightcode-0.0.9.tar.gz",
"platform": null,
"description": "\n# `gradio_highlightcode`\n<a href=\"https://pypi.org/project/gradio_highlightcode/\" target=\"_blank\"><img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/gradio_highlightcode\"></a> \n\nInference from: https://pypi.org/project/gradio-highlightedcode/ \n Update Custom Package to the Latest Gradio Code (Support for C, C++...) and optimized invocation methods.\n\n## Installation\n\n```bash\npip install gradio_highlightcode\n```\n\n## Usage\n\n```python\n\nimport gradio as gr\nfrom gradio_highlightcode import highlightcode\nimport time\n\n\nexample = highlightcode().example_value()\n\ninitial_value = \"\"\"\n#include <stdio.h>\n\nint main() {\n printf(\"Hello, World!\\n\");\n return 0;\n}\n\n\"\"\"\n\nwith gr.Blocks() as demo:\n code = highlightcode(initial_value, language=\"c\", highlights=[(3, 6, \"rgb(255 254 213)\")])\n\nif __name__ == \"__main__\":\n demo.launch()\n```\n\n## `highlightcode`\n\n### Initialization\n\n<table>\n<thead>\n<tr>\n<th align=\"left\">name</th>\n<th align=\"left\" style=\"width: 25%;\">type</th>\n<th align=\"left\">default</th>\n<th align=\"left\">description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td align=\"left\"><code>value</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | Callable | tuple[str] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Default value to show in the code editor. If callable, the function will be called whenever the app loads to set the initial value of the component.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>language</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nLiteral[\n \"python\",\n \"c\",\n \"cpp\",\n \"markdown\",\n \"json\",\n \"html\",\n \"css\",\n \"javascript\",\n \"typescript\",\n \"yaml\",\n \"dockerfile\",\n \"shell\",\n \"r\",\n \"sql\",\n \"sql-msSQL\",\n \"sql-mySQL\",\n \"sql-mariaDB\",\n \"sql-sqlite\",\n \"sql-cassandra\",\n \"sql-plSQL\",\n \"sql-hive\",\n \"sql-pgSQL\",\n \"sql-gql\",\n \"sql-gpSQL\",\n \"sql-sparkSQL\",\n \"sql-esper\",\n ]\n | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">The language to display the code as. Supported languages listed in `gr.Code.languages`.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>highlights</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nlist[tuple[int, int, str]] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Specifies the lines to highlight. Use the first number for the starting line, the second for the ending line, and the last parameter for the color.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>every</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nTimer | float | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>inputs</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nComponent | list[Component] | set[Component] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>lines</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint\n```\n\n</td>\n<td align=\"left\"><code>5</code></td>\n<td align=\"left\">None</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>label</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>interactive</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Whether user should be able to enter code or only view it.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>show_label</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">if True, will display label.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>container</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">If True, will place the component in a container - providing some extra padding around the border.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>scale</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>min_width</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint\n```\n\n</td>\n<td align=\"left\"><code>160</code></td>\n<td align=\"left\">minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>visible</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">If False, component will be hidden.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>elem_id</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>elem_classes</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nlist[str] | str | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>render</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>key</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | str | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.</td>\n</tr>\n</tbody></table>\n\n\n### Events\n\n| name | description |\n|:-----|:------------|\n| `change` | Triggered when the value of the highlightcode changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See `.input()` for a listener that is only triggered by user input. |\n| `input` | This listener is triggered when the user changes the value of the highlightcode. |\n| `focus` | This listener is triggered when the highlightcode is focused. |\n| `blur` | This listener is triggered when the highlightcode is unfocused/blurred. |\n\n\n\n### User function\n\nThe impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).\n\n- When used as an Input, the component only impacts the input signature of the user function.\n- When used as an output, the component only impacts the return signature of the user function.\n\nThe code snippet below is accurate in cases where the component is used as both an input and an output.\n\n- **As output:** Is passed, passes the code entered as a `str`.\n- **As input:** Should return, expects a `str` of code or a single-element `tuple`: (filepath,) with the `str` path to a file containing the code.\n\n ```python\n def predict(\n value: str | None\n ) -> tuple[str] | str | None:\n return value\n ```\n \n",
"bugtrack_url": null,
"license": null,
"summary": "Inference from: https://pypi.org/project/gradio-highlightedcode/ Update Custom Package to the Latest Gradio Code (Support for C, C++...) and optimized invocation methods.",
"version": "0.0.9",
"project_urls": null,
"split_keywords": [
"gradio-custom-component",
" gradio-template-code"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b2ec316f25780bfdd88ceb602f8c047da62b121de0c5ce311545a397101ef87",
"md5": "79ec99de043666ffd90092134d553eaa",
"sha256": "2bcf773a140db57438de8cadc4faf02b1ddacf80b9ee3426b566dd7b705781f5"
},
"downloads": -1,
"filename": "gradio_highlightcode-0.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79ec99de043666ffd90092134d553eaa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 336042,
"upload_time": "2024-07-14T07:07:30",
"upload_time_iso_8601": "2024-07-14T07:07:30.871771Z",
"url": "https://files.pythonhosted.org/packages/2b/2e/c316f25780bfdd88ceb602f8c047da62b121de0c5ce311545a397101ef87/gradio_highlightcode-0.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a097df3c90dc019757b88a8825b7fbe53b856f4639c2b0f0a3ae0cb8bea77a86",
"md5": "8645a02167d243714a5b54ca21389850",
"sha256": "f38f8300a2e344a80f8ce92b575684f0b2b89061d6e79c7fbb7bcb9cfd1b4d87"
},
"downloads": -1,
"filename": "gradio_highlightcode-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "8645a02167d243714a5b54ca21389850",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 385781,
"upload_time": "2024-07-14T07:07:35",
"upload_time_iso_8601": "2024-07-14T07:07:35.542393Z",
"url": "https://files.pythonhosted.org/packages/a0/97/df3c90dc019757b88a8825b7fbe53b856f4639c2b0f0a3ae0cb8bea77a86/gradio_highlightcode-0.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-14 07:07:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gradio-highlightcode"
}
