Search is not available for this dataset
identifier stringlengths 1 155 | parameters stringlengths 2 6.09k | docstring stringlengths 11 63.4k | docstring_summary stringlengths 0 63.4k | function stringlengths 29 99.8k | function_tokens list | start_point list | end_point list | language stringclasses 1
value | docstring_language stringlengths 2 7 | docstring_language_predictions stringlengths 18 23 | is_langid_reliable stringclasses 2
values |
|---|---|---|---|---|---|---|---|---|---|---|---|
Annotation.startarrowsize | (self) |
Sets the size of the start annotation arrow head, relative to
`arrowwidth`. A value of 1 (default) gives a head about 3x as
wide as the line.
The 'startarrowsize' property is a number and may be specified as:
- An int or float in the interval [0.3, inf]
Returns
... |
Sets the size of the start annotation arrow head, relative to
`arrowwidth`. A value of 1 (default) gives a head about 3x as
wide as the line.
The 'startarrowsize' property is a number and may be specified as:
- An int or float in the interval [0.3, inf] | def startarrowsize(self):
"""
Sets the size of the start annotation arrow head, relative to
`arrowwidth`. A value of 1 (default) gives a head about 3x as
wide as the line.
The 'startarrowsize' property is a number and may be specified as:
- An int or float in the i... | [
"def",
"startarrowsize",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"startarrowsize\"",
"]"
] | [
688,
4
] | [
701,
37
] | python | en | ['en', 'error', 'th'] | False |
Annotation.startstandoff | (self) |
Sets a distance, in pixels, to move the start arrowhead away
from the position it is pointing at, for example to point at
the edge of a marker independent of zoom. Note that this
shortens the arrow from the `ax` / `ay` vector, in contrast to
`xshift` / `yshift` which moves every... |
Sets a distance, in pixels, to move the start arrowhead away
from the position it is pointing at, for example to point at
the edge of a marker independent of zoom. Note that this
shortens the arrow from the `ax` / `ay` vector, in contrast to
`xshift` / `yshift` which moves every... | def startstandoff(self):
"""
Sets a distance, in pixels, to move the start arrowhead away
from the position it is pointing at, for example to point at
the edge of a marker independent of zoom. Note that this
shortens the arrow from the `ax` / `ay` vector, in contrast to
`... | [
"def",
"startstandoff",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"startstandoff\"",
"]"
] | [
710,
4
] | [
725,
36
] | python | en | ['en', 'error', 'th'] | False |
Annotation.templateitemname | (self) |
Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with `templateitemname` matching its `name`,
alongside your modifications (includ... |
Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with `templateitemname` matching its `name`,
alongside your modifications (includ... | def templateitemname(self):
"""
Used to refer to a named item in this array in the template.
Named items from the template will be created even without a
matching item in the input figure, but you can modify one by
making an item with `templateitemname` matching its `name`,
... | [
"def",
"templateitemname",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"templateitemname\"",
"]"
] | [
734,
4
] | [
753,
39
] | python | en | ['en', 'error', 'th'] | False |
Annotation.text | (self) |
Sets the text associated with this annotation. Plotly uses a
subset of HTML tags to do things like newline (<br>), bold
(<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>).
Tags <em>, <sup>, <sub> <span> are also supported.
The 'text' property is a string and must... |
Sets the text associated with this annotation. Plotly uses a
subset of HTML tags to do things like newline (<br>), bold
(<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>).
Tags <em>, <sup>, <sub> <span> are also supported.
The 'text' property is a string and must... | def text(self):
"""
Sets the text associated with this annotation. Plotly uses a
subset of HTML tags to do things like newline (<br>), bold
(<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>).
Tags <em>, <sup>, <sub> <span> are also supported.
The 'text' pr... | [
"def",
"text",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"text\"",
"]"
] | [
762,
4
] | [
777,
27
] | python | en | ['en', 'error', 'th'] | False |
Annotation.textangle | (self) |
Sets the angle at which the `text` is drawn with respect to the
horizontal.
The 'textangle' property is a angle (in degrees) that may be
specified as a number between -180 and 180. Numeric values outside this
range are converted to the equivalent value
(e.g. 270 is ... |
Sets the angle at which the `text` is drawn with respect to the
horizontal.
The 'textangle' property is a angle (in degrees) that may be
specified as a number between -180 and 180. Numeric values outside this
range are converted to the equivalent value
(e.g. 270 is ... | def textangle(self):
"""
Sets the angle at which the `text` is drawn with respect to the
horizontal.
The 'textangle' property is a angle (in degrees) that may be
specified as a number between -180 and 180. Numeric values outside this
range are converted to the equiva... | [
"def",
"textangle",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"textangle\"",
"]"
] | [
786,
4
] | [
800,
32
] | python | en | ['en', 'error', 'th'] | False |
Annotation.valign | (self) |
Sets the vertical alignment of the `text` within the box. Has
an effect only if an explicit height is set to override the
text height.
The 'valign' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'mid... |
Sets the vertical alignment of the `text` within the box. Has
an effect only if an explicit height is set to override the
text height.
The 'valign' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'mid... | def valign(self):
"""
Sets the vertical alignment of the `text` within the box. Has
an effect only if an explicit height is set to override the
text height.
The 'valign' property is an enumeration that may be specified as:
- One of the following enumeration values:... | [
"def",
"valign",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"valign\"",
"]"
] | [
809,
4
] | [
823,
29
] | python | en | ['en', 'error', 'th'] | False |
Annotation.visible | (self) |
Determines whether or not this annotation is visible.
The 'visible' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Determines whether or not this annotation is visible.
The 'visible' property must be specified as a bool
(either True, or False) | def visible(self):
"""
Determines whether or not this annotation is visible.
The 'visible' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
return self["visible"] | [
"def",
"visible",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"visible\"",
"]"
] | [
832,
4
] | [
843,
30
] | python | en | ['en', 'error', 'th'] | False |
Annotation.width | (self) |
Sets an explicit width for the text box. null (default) lets
the text set the box width. Wider text will be clipped. There
is no automatic wrapping; use <br> to start a new line.
The 'width' property is a number and may be specified as:
- An int or float in the interval [... |
Sets an explicit width for the text box. null (default) lets
the text set the box width. Wider text will be clipped. There
is no automatic wrapping; use <br> to start a new line.
The 'width' property is a number and may be specified as:
- An int or float in the interval [... | def width(self):
"""
Sets an explicit width for the text box. null (default) lets
the text set the box width. Wider text will be clipped. There
is no automatic wrapping; use <br> to start a new line.
The 'width' property is a number and may be specified as:
- An in... | [
"def",
"width",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"width\"",
"]"
] | [
852,
4
] | [
865,
28
] | python | en | ['en', 'error', 'th'] | False |
Annotation.x | (self) |
Sets the annotation's x position.
The 'x' property accepts values of any type
Returns
-------
Any
|
Sets the annotation's x position.
The 'x' property accepts values of any type | def x(self):
"""
Sets the annotation's x position.
The 'x' property accepts values of any type
Returns
-------
Any
"""
return self["x"] | [
"def",
"x",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"x\"",
"]"
] | [
874,
4
] | [
884,
24
] | python | en | ['en', 'error', 'th'] | False |
Annotation.xanchor | (self) |
Sets the text box's horizontal position anchor This anchor
binds the `x` position to the "left", "center" or "right" of
the annotation. For example, if `x` is set to 1, `xref` to
"paper" and `xanchor` to "right" then the right-most portion of
the annotation lines up with the rig... |
Sets the text box's horizontal position anchor This anchor
binds the `x` position to the "left", "center" or "right" of
the annotation. For example, if `x` is set to 1, `xref` to
"paper" and `xanchor` to "right" then the right-most portion of
the annotation lines up with the rig... | def xanchor(self):
"""
Sets the text box's horizontal position anchor This anchor
binds the `x` position to the "left", "center" or "right" of
the annotation. For example, if `x` is set to 1, `xref` to
"paper" and `xanchor` to "right" then the right-most portion of
the an... | [
"def",
"xanchor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"xanchor\"",
"]"
] | [
893,
4
] | [
913,
30
] | python | en | ['en', 'error', 'th'] | False |
Annotation.xshift | (self) |
Shifts the position of the whole annotation and arrow to the
right (positive) or left (negative) by this many pixels.
The 'xshift' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
|
Shifts the position of the whole annotation and arrow to the
right (positive) or left (negative) by this many pixels.
The 'xshift' property is a number and may be specified as:
- An int or float | def xshift(self):
"""
Shifts the position of the whole annotation and arrow to the
right (positive) or left (negative) by this many pixels.
The 'xshift' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
... | [
"def",
"xshift",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"xshift\"",
"]"
] | [
922,
4
] | [
934,
29
] | python | en | ['en', 'error', 'th'] | False |
Annotation.y | (self) |
Sets the annotation's y position.
The 'y' property accepts values of any type
Returns
-------
Any
|
Sets the annotation's y position.
The 'y' property accepts values of any type | def y(self):
"""
Sets the annotation's y position.
The 'y' property accepts values of any type
Returns
-------
Any
"""
return self["y"] | [
"def",
"y",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"y\"",
"]"
] | [
943,
4
] | [
953,
24
] | python | en | ['en', 'error', 'th'] | False |
Annotation.yanchor | (self) |
Sets the text box's vertical position anchor This anchor binds
the `y` position to the "top", "middle" or "bottom" of the
annotation. For example, if `y` is set to 1, `yref` to "paper"
and `yanchor` to "top" then the top-most portion of the
annotation lines up with the top-most ... |
Sets the text box's vertical position anchor This anchor binds
the `y` position to the "top", "middle" or "bottom" of the
annotation. For example, if `y` is set to 1, `yref` to "paper"
and `yanchor` to "top" then the top-most portion of the
annotation lines up with the top-most ... | def yanchor(self):
"""
Sets the text box's vertical position anchor This anchor binds
the `y` position to the "top", "middle" or "bottom" of the
annotation. For example, if `y` is set to 1, `yref` to "paper"
and `yanchor` to "top" then the top-most portion of the
annotati... | [
"def",
"yanchor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"yanchor\"",
"]"
] | [
962,
4
] | [
982,
30
] | python | en | ['en', 'error', 'th'] | False |
Annotation.yshift | (self) |
Shifts the position of the whole annotation and arrow up
(positive) or down (negative) by this many pixels.
The 'yshift' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
|
Shifts the position of the whole annotation and arrow up
(positive) or down (negative) by this many pixels.
The 'yshift' property is a number and may be specified as:
- An int or float | def yshift(self):
"""
Shifts the position of the whole annotation and arrow up
(positive) or down (negative) by this many pixels.
The 'yshift' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
"""
... | [
"def",
"yshift",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"yshift\"",
"]"
] | [
991,
4
] | [
1003,
29
] | python | en | ['en', 'error', 'th'] | False |
Annotation.z | (self) |
Sets the annotation's z position.
The 'z' property accepts values of any type
Returns
-------
Any
|
Sets the annotation's z position.
The 'z' property accepts values of any type | def z(self):
"""
Sets the annotation's z position.
The 'z' property accepts values of any type
Returns
-------
Any
"""
return self["z"] | [
"def",
"z",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"z\"",
"]"
] | [
1012,
4
] | [
1022,
24
] | python | en | ['en', 'error', 'th'] | False |
Annotation.__init__ | (
self,
arg=None,
align=None,
arrowcolor=None,
arrowhead=None,
arrowside=None,
arrowsize=None,
arrowwidth=None,
ax=None,
ay=None,
bgcolor=None,
bordercolor=None,
borderpad=None,
borderwidth=None,
capt... |
Construct a new Annotation object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.layout.scene.Annotation`
align
Sets the horizontal alignment of th... |
Construct a new Annotation object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.layout.scene.Annotation`
align
Sets the horizontal alignment of th... | def __init__(
self,
arg=None,
align=None,
arrowcolor=None,
arrowhead=None,
arrowside=None,
arrowsize=None,
arrowwidth=None,
ax=None,
ay=None,
bgcolor=None,
bordercolor=None,
borderpad=None,
borderwidth=None,
... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"align",
"=",
"None",
",",
"arrowcolor",
"=",
"None",
",",
"arrowhead",
"=",
"None",
",",
"arrowside",
"=",
"None",
",",
"arrowsize",
"=",
"None",
",",
"arrowwidth",
"=",
"None",
",",
"ax"... | [
1191,
4
] | [
1587,
34
] | python | en | ['en', 'error', 'th'] | False |
readit | (in_file, per_lines=False, in_encoding='utf-8', in_errors=None) |
Reads a file.
Parameters
----------
in_file : str
A file path
per_lines : bool, optional
If True, returns a list of all lines, by default False
in_encoding : str, optional
Sets the encoding, by default 'utf-8'
in_errors : str, optional
How to handle encoding... |
Reads a file. | def readit(in_file, per_lines=False, in_encoding='utf-8', in_errors=None):
"""
Reads a file.
Parameters
----------
in_file : str
A file path
per_lines : bool, optional
If True, returns a list of all lines, by default False
in_encoding : str, optional
Sets the encodin... | [
"def",
"readit",
"(",
"in_file",
",",
"per_lines",
"=",
"False",
",",
"in_encoding",
"=",
"'utf-8'",
",",
"in_errors",
"=",
"None",
")",
":",
"with",
"open",
"(",
"in_file",
",",
"'r'",
",",
"encoding",
"=",
"in_encoding",
",",
"errors",
"=",
"in_errors"... | [
21,
0
] | [
46,
19
] | python | en | ['en', 'error', 'th'] | False |
writeit | (in_file, in_data, append=False, in_encoding='utf-8', in_errors=None) |
Writes to a file.
Parameters
----------
in_file : str
The target file path
in_data : str
The data to write
append : bool, optional
If True appends the data to the file, by default False
in_encoding : str, optional
Sets the encoding, by default 'utf-8'
|
Writes to a file. | def writeit(in_file, in_data, append=False, in_encoding='utf-8', in_errors=None):
"""
Writes to a file.
Parameters
----------
in_file : str
The target file path
in_data : str
The data to write
append : bool, optional
If True appends the data to the file, by default F... | [
"def",
"writeit",
"(",
"in_file",
",",
"in_data",
",",
"append",
"=",
"False",
",",
"in_encoding",
"=",
"'utf-8'",
",",
"in_errors",
"=",
"None",
")",
":",
"_write_type",
"=",
"'w'",
"if",
"append",
"is",
"False",
"else",
"'a'",
"with",
"open",
"(",
"i... | [
49,
0
] | [
66,
29
] | python | en | ['en', 'error', 'th'] | False |
pathmaker | (first_segment, *in_path_segments, rev=False) |
Normalizes input path or path fragments, replaces '\\\\' with '/' and combines fragments.
Parameters
----------
first_segment : str
first path segment, if it is 'cwd' gets replaced by 'os.getcwd()'
rev : bool, optional
If 'True' reverts path back to Windows default, by default None... |
Normalizes input path or path fragments, replaces '\\\\' with '/' and combines fragments. | def pathmaker(first_segment, *in_path_segments, rev=False):
"""
Normalizes input path or path fragments, replaces '\\\\' with '/' and combines fragments.
Parameters
----------
first_segment : str
first path segment, if it is 'cwd' gets replaced by 'os.getcwd()'
rev : bool, optional
... | [
"def",
"pathmaker",
"(",
"first_segment",
",",
"*",
"in_path_segments",
",",
"rev",
"=",
"False",
")",
":",
"_path",
"=",
"first_segment",
"_path",
"=",
"os",
".",
"path",
".",
"join",
"(",
"_path",
",",
"*",
"in_path_segments",
")",
"if",
"rev",
"is",
... | [
69,
0
] | [
91,
60
] | python | en | ['en', 'error', 'th'] | False |
__init__ | (self, queue_name: str, immediate_delete: bool = True, visibility_timeout: int = None, minimum_visibility_timeout: int = 0, **kwargs) |
SQS access
:param queue_name: queue name
:param immediate_delete: True to immediately delete read message(s) upon receipt, False to require the user to call delete_message()
:param visibility_timeout: visibility timeout (if explicitly given) - set to None to automatically attempt to de... |
SQS access | def __init__(self, queue_name: str, immediate_delete: bool = True, visibility_timeout: int = None, minimum_visibility_timeout: int = 0, **kwargs):
"""
SQS access
:param queue_name: queue name
:param immediate_delete: True to immediately delete read message(s) upon receipt, False to requ... | [
"def",
"__init__",
"(",
"self",
",",
"queue_name",
":",
"str",
",",
"immediate_delete",
":",
"bool",
"=",
"True",
",",
"visibility_timeout",
":",
"int",
"=",
"None",
",",
"minimum_visibility_timeout",
":",
"int",
"=",
"0",
",",
"*",
"*",
"kwargs",
")",
"... | [
51,
4
] | [
80,
29
] | python | en | ['en', 'error', 'th'] | False |
_get_response_history_file_path | (self) |
get response history file path
:return:
|
get response history file path | def _get_response_history_file_path(self) -> Path:
"""
get response history file path
:return:
"""
p = Path(appdirs.user_data_dir(__application_name__, __author__), "response", f"{self.queue_name}.json")
log.debug(f'response history file path : "{p}"')
return p | [
"def",
"_get_response_history_file_path",
"(",
"self",
")",
"->",
"Path",
":",
"p",
"=",
"Path",
"(",
"appdirs",
".",
"user_data_dir",
"(",
"__application_name__",
",",
"__author__",
")",
",",
"\"response\"",
",",
"f\"{self.queue_name}.json\"",
")",
"log",
".",
... | [
88,
4
] | [
96,
16
] | python | en | ['en', 'error', 'th'] | False |
create_queue | (self) |
create SQS queue
:return: queue URL
|
create SQS queue | def create_queue(self) -> str:
"""
create SQS queue
:return: queue URL
"""
return self.client.create_queue(QueueName=self.queue_name)["QueueUrl"] | [
"def",
"create_queue",
"(",
"self",
")",
"->",
"str",
":",
"return",
"self",
".",
"client",
".",
"create_queue",
"(",
"QueueName",
"=",
"self",
".",
"queue_name",
")",
"[",
"\"QueueUrl\"",
"]"
] | [
99,
4
] | [
105,
78
] | python | en | ['en', 'error', 'th'] | False |
delete_queue | (self) |
delete queue
|
delete queue
| def delete_queue(self):
"""
delete queue
"""
self.resource.get_queue_by_name(QueueName=self.queue_name).delete() | [
"def",
"delete_queue",
"(",
"self",
")",
":",
"self",
".",
"resource",
".",
"get_queue_by_name",
"(",
"QueueName",
"=",
"self",
".",
"queue_name",
")",
".",
"delete",
"(",
")"
] | [
107,
4
] | [
111,
75
] | python | en | ['en', 'error', 'th'] | False |
exists | (self) |
test if SQS queue exists
:return: True if exists
|
test if SQS queue exists | def exists(self) -> bool:
"""
test if SQS queue exists
:return: True if exists
"""
try:
self.resource.get_queue_by_name(QueueName=self.queue_name)
queue_exists = True
except self.client.exceptions.QueueDoesNotExist:
queue_exists = Fals... | [
"def",
"exists",
"(",
"self",
")",
"->",
"bool",
":",
"try",
":",
"self",
".",
"resource",
".",
"get_queue_by_name",
"(",
"QueueName",
"=",
"self",
".",
"queue_name",
")",
"queue_exists",
"=",
"True",
"except",
"self",
".",
"client",
".",
"exceptions",
"... | [
114,
4
] | [
125,
27
] | python | en | ['en', 'error', 'th'] | False |
get_user | (username: str, api_key: str, **kwargs) | Creates a new user, validate its credentials and returns it
|funccoro|
Args:
username: username as specified on the challonge website
api_key: key as found on the challonge
`settings <https://challonge.com/settings/developer>`_
Returns:
User: a logged in user if no ex... | Creates a new user, validate its credentials and returns it | async def get_user(username: str, api_key: str, **kwargs) -> User:
""" Creates a new user, validate its credentials and returns it
|funccoro|
Args:
username: username as specified on the challonge website
api_key: key as found on the challonge
`settings <https://challonge.com/s... | [
"async",
"def",
"get_user",
"(",
"username",
":",
"str",
",",
"api_key",
":",
"str",
",",
"*",
"*",
"kwargs",
")",
"->",
"User",
":",
"new_user",
"=",
"User",
"(",
"username",
",",
"api_key",
",",
"*",
"*",
"kwargs",
")",
"await",
"new_user",
".",
... | [
183,
0
] | [
202,
19
] | python | en | ['en', 'en', 'en'] | True |
User.validate | (self) | checks whether the current user is connected
|methcoro|
Raises:
APIException
| checks whether the current user is connected | async def validate(self):
""" checks whether the current user is connected
|methcoro|
Raises:
APIException
"""
await self.connection('GET', 'tournaments') | [
"async",
"def",
"validate",
"(",
"self",
")",
":",
"await",
"self",
".",
"connection",
"(",
"'GET'",
",",
"'tournaments'",
")"
] | [
46,
4
] | [
55,
51
] | python | en | ['en', 'en', 'en'] | True |
User.get_tournament | (self, t_id: int = None, url: str = None, subdomain: str = None, force_update=False) | gets a tournament with its id or url or url+subdomain
Note: from the API, it can't be known if the retrieved tournament was made from this user.
Thus, any tournament is added to the local list of tournaments, but some functions (updates/destroy...) cannot be used for tournaments not owned by this user... | gets a tournament with its id or url or url+subdomain
Note: from the API, it can't be known if the retrieved tournament was made from this user.
Thus, any tournament is added to the local list of tournaments, but some functions (updates/destroy...) cannot be used for tournaments not owned by this user... | async def get_tournament(self, t_id: int = None, url: str = None, subdomain: str = None, force_update=False) -> Tournament:
""" gets a tournament with its id or url or url+subdomain
Note: from the API, it can't be known if the retrieved tournament was made from this user.
Thus, any tournament i... | [
"async",
"def",
"get_tournament",
"(",
"self",
",",
"t_id",
":",
"int",
"=",
"None",
",",
"url",
":",
"str",
"=",
"None",
",",
"subdomain",
":",
"str",
"=",
"None",
",",
"force_update",
"=",
"False",
")",
"->",
"Tournament",
":",
"assert_or_raise",
"("... | [
57,
4
] | [
94,
22
] | python | en | ['en', 'en', 'en'] | True |
User.get_tournaments | (self, subdomain: str = None, force_update: bool = False) | gets all user's tournaments
|methcoro|
Args:
subdomain: *optional* subdomain needs to be given explicitely to get tournaments in a subdomain
force_update: *optional* set to True to force the data update from Challonge
Returns:
list[Tournament]: list of all... | gets all user's tournaments | async def get_tournaments(self, subdomain: str = None, force_update: bool = False) -> list:
""" gets all user's tournaments
|methcoro|
Args:
subdomain: *optional* subdomain needs to be given explicitely to get tournaments in a subdomain
force_update: *optional* set to T... | [
"async",
"def",
"get_tournaments",
"(",
"self",
",",
"subdomain",
":",
"str",
"=",
"None",
",",
"force_update",
":",
"bool",
"=",
"False",
")",
"->",
"list",
":",
"if",
"self",
".",
"tournaments",
"is",
"None",
":",
"force_update",
"=",
"True",
"self",
... | [
96,
4
] | [
137,
31
] | python | en | ['en', 'en', 'en'] | True |
User.create_tournament | (self, name: str, url: str, tournament_type: TournamentType = TournamentType.single_elimination, **params) | creates a simple tournament with basic options
|methcoro|
Args:
name: name of the new tournament
url: url of the new tournament (http://challonge.com/url)
tournament_type: Defaults to TournamentType.single_elimination
params: optional params (see http:/... | creates a simple tournament with basic options | async def create_tournament(self, name: str, url: str, tournament_type: TournamentType = TournamentType.single_elimination, **params) -> Tournament:
""" creates a simple tournament with basic options
|methcoro|
Args:
name: name of the new tournament
url: url of the new ... | [
"async",
"def",
"create_tournament",
"(",
"self",
",",
"name",
":",
"str",
",",
"url",
":",
"str",
",",
"tournament_type",
":",
"TournamentType",
"=",
"TournamentType",
".",
"single_elimination",
",",
"*",
"*",
"params",
")",
"->",
"Tournament",
":",
"params... | [
139,
4
] | [
164,
67
] | python | en | ['en', 'en', 'en'] | True |
User.destroy_tournament | (self, t: Tournament) | completely removes a tournament from Challonge
|methcoro|
Note:
|from_api| Deletes a tournament along with all its associated records. There is no undo, so use with care!
Raises:
APIException
| completely removes a tournament from Challonge | async def destroy_tournament(self, t: Tournament):
""" completely removes a tournament from Challonge
|methcoro|
Note:
|from_api| Deletes a tournament along with all its associated records. There is no undo, so use with care!
Raises:
APIException
"""
... | [
"async",
"def",
"destroy_tournament",
"(",
"self",
",",
"t",
":",
"Tournament",
")",
":",
"await",
"self",
".",
"connection",
"(",
"'DELETE'",
",",
"'tournaments/{}'",
".",
"format",
"(",
"t",
".",
"id",
")",
")",
"if",
"t",
"in",
"self",
".",
"tournam... | [
166,
4
] | [
180,
38
] | python | en | ['en', 'en', 'en'] | True |
validate_coerce_format | (fmt) |
Validate / coerce a user specified image format, and raise an informative
exception if format is invalid.
Parameters
----------
fmt
A value that may or may not be a valid image format string.
Returns
-------
str or None
A valid image format string as supported by orca.... |
Validate / coerce a user specified image format, and raise an informative
exception if format is invalid. | def validate_coerce_format(fmt):
"""
Validate / coerce a user specified image format, and raise an informative
exception if format is invalid.
Parameters
----------
fmt
A value that may or may not be a valid image format string.
Returns
-------
str or None
A valid i... | [
"def",
"validate_coerce_format",
"(",
"fmt",
")",
":",
"# Let None pass through",
"if",
"fmt",
"is",
"None",
":",
"return",
"None",
"# Check format type",
"if",
"not",
"isinstance",
"(",
"fmt",
",",
"string_types",
")",
"or",
"not",
"fmt",
":",
"raise_format_val... | [
46,
0
] | [
94,
34
] | python | en | ['en', 'error', 'th'] | False |
find_open_port | () |
Use the socket module to find an open port.
Returns
-------
int
An open port
|
Use the socket module to find an open port. | def find_open_port():
"""
Use the socket module to find an open port.
Returns
-------
int
An open port
"""
s = socket.socket()
s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
s.bind(("", 0))
_, port = s.getsockname()
s.close()
return port | [
"def",
"find_open_port",
"(",
")",
":",
"s",
"=",
"socket",
".",
"socket",
"(",
")",
"s",
".",
"setsockopt",
"(",
"socket",
".",
"SOL_SOCKET",
",",
"socket",
".",
"SO_REUSEADDR",
",",
"1",
")",
"s",
".",
"bind",
"(",
"(",
"\"\"",
",",
"0",
")",
"... | [
97,
0
] | [
112,
15
] | python | en | ['en', 'error', 'th'] | False |
which_py2 | (cmd, mode=os.F_OK | os.X_OK, path=None) |
Backport (unmodified) of shutil.which command from Python 3.6
Remove this when Python 2 support is dropped
Given a command, mode, and a PATH string, return the path which
conforms to the given mode on the PATH, or None if there is no such
file.
`mode` defaults to os.F_OK | os.X_OK. `path` def... |
Backport (unmodified) of shutil.which command from Python 3.6
Remove this when Python 2 support is dropped | def which_py2(cmd, mode=os.F_OK | os.X_OK, path=None):
"""
Backport (unmodified) of shutil.which command from Python 3.6
Remove this when Python 2 support is dropped
Given a command, mode, and a PATH string, return the path which
conforms to the given mode on the PATH, or None if there is no such
... | [
"def",
"which_py2",
"(",
"cmd",
",",
"mode",
"=",
"os",
".",
"F_OK",
"|",
"os",
".",
"X_OK",
",",
"path",
"=",
"None",
")",
":",
"# Check that a given file can be accessed with the correct mode.",
"# Additionally check that `file` is not a directory, as on Windows",
"# di... | [
115,
0
] | [
177,
15
] | python | en | ['en', 'error', 'th'] | False |
which | (cmd) |
Return the absolute path of the input executable string, based on the
user's current PATH variable.
This is a wrapper for shutil.which that is compatible with Python 2.
Parameters
----------
cmd: str
String containing the name of an executable on the user's path.
Returns
----... |
Return the absolute path of the input executable string, based on the
user's current PATH variable. | def which(cmd):
"""
Return the absolute path of the input executable string, based on the
user's current PATH variable.
This is a wrapper for shutil.which that is compatible with Python 2.
Parameters
----------
cmd: str
String containing the name of an executable on the user's path... | [
"def",
"which",
"(",
"cmd",
")",
":",
"if",
"sys",
".",
"version_info",
">",
"(",
"3",
",",
"0",
")",
":",
"import",
"shutil",
"return",
"shutil",
".",
"which",
"(",
"cmd",
")",
"else",
":",
"return",
"which_py2",
"(",
"cmd",
")"
] | [
180,
0
] | [
204,
29
] | python | en | ['en', 'error', 'th'] | False |
orca_env | () |
Context manager to clear and restore environment variables that are
problematic for orca to function properly
NODE_OPTIONS: When this variable is set, orca <v1.2 will have a
segmentation fault due to an electron bug.
See: https://github.com/electron/electron/issues/12695
ELECTRON_RUN_AS_NODE:... |
Context manager to clear and restore environment variables that are
problematic for orca to function properly | def orca_env():
"""
Context manager to clear and restore environment variables that are
problematic for orca to function properly
NODE_OPTIONS: When this variable is set, orca <v1.2 will have a
segmentation fault due to an electron bug.
See: https://github.com/electron/electron/issues/12695
... | [
"def",
"orca_env",
"(",
")",
":",
"clear_env_vars",
"=",
"[",
"\"NODE_OPTIONS\"",
",",
"\"ELECTRON_RUN_AS_NODE\"",
",",
"\"LD_PRELOAD\"",
"]",
"orig_env_vars",
"=",
"{",
"}",
"try",
":",
"# Clear and save",
"orig_env_vars",
".",
"update",
"(",
"{",
"var",
":",
... | [
978,
0
] | [
1003,
33
] | python | en | ['en', 'error', 'th'] | False |
validate_executable | () |
Attempt to find and validate the orca executable specified by the
`plotly.io.orca.config.executable` property.
If the `plotly.io.orca.status.state` property is 'validated' or 'running'
then this function does nothing.
How it works:
- First, it searches the system PATH for an executable that... |
Attempt to find and validate the orca executable specified by the
`plotly.io.orca.config.executable` property. | def validate_executable():
"""
Attempt to find and validate the orca executable specified by the
`plotly.io.orca.config.executable` property.
If the `plotly.io.orca.status.state` property is 'validated' or 'running'
then this function does nothing.
How it works:
- First, it searches the ... | [
"def",
"validate_executable",
"(",
")",
":",
"# Check state",
"# -----------",
"if",
"status",
".",
"state",
"!=",
"\"unvalidated\"",
":",
"# Nothing more to do",
"return",
"# Initialize error messages",
"# -------------------------",
"install_location_instructions",
"=",
"\"... | [
1008,
0
] | [
1257,
40
] | python | en | ['en', 'error', 'th'] | False |
reset_status | () |
Shutdown the running orca server, if any, and reset the orca status
to unvalidated.
This command is only needed if the desired orca executable is changed
during an interactive session.
Returns
-------
None
|
Shutdown the running orca server, if any, and reset the orca status
to unvalidated. | def reset_status():
"""
Shutdown the running orca server, if any, and reset the orca status
to unvalidated.
This command is only needed if the desired orca executable is changed
during an interactive session.
Returns
-------
None
"""
shutdown_server()
status._props["executa... | [
"def",
"reset_status",
"(",
")",
":",
"shutdown_server",
"(",
")",
"status",
".",
"_props",
"[",
"\"executable_list\"",
"]",
"=",
"None",
"status",
".",
"_props",
"[",
"\"version\"",
"]",
"=",
"None",
"status",
".",
"_props",
"[",
"\"state\"",
"]",
"=",
... | [
1260,
0
] | [
1275,
42
] | python | en | ['en', 'error', 'th'] | False |
shutdown_server | () |
Shutdown the running orca server process, if any
Returns
-------
None
|
Shutdown the running orca server process, if any | def shutdown_server():
"""
Shutdown the running orca server process, if any
Returns
-------
None
"""
# Use double-check locking to make sure the properties of orca_state
# are updated consistently across threads.
if orca_state["proc"] is not None:
with orca_lock:
... | [
"def",
"shutdown_server",
"(",
")",
":",
"# Use double-check locking to make sure the properties of orca_state",
"# are updated consistently across threads.",
"if",
"orca_state",
"[",
"\"proc\"",
"]",
"is",
"not",
"None",
":",
"with",
"orca_lock",
":",
"if",
"orca_state",
"... | [
1293,
0
] | [
1344,
47
] | python | en | ['en', 'error', 'th'] | False |
ensure_server | () |
Start an orca server if none is running. If a server is already running,
then reset the timeout countdown
Returns
-------
None
|
Start an orca server if none is running. If a server is already running,
then reset the timeout countdown | def ensure_server():
"""
Start an orca server if none is running. If a server is already running,
then reset the timeout countdown
Returns
-------
None
"""
# Validate psutil
if psutil is None:
raise ValueError(
"""\
Image generation requires the psutil package.
... | [
"def",
"ensure_server",
"(",
")",
":",
"# Validate psutil",
"if",
"psutil",
"is",
"None",
":",
"raise",
"ValueError",
"(",
"\"\"\"\\\nImage generation requires the psutil package.\n\nInstall using pip:\n $ pip install psutil\n\nInstall using conda:\n $ conda install psutil\n\"\"\""... | [
1348,
0
] | [
1450,
48
] | python | en | ['en', 'error', 'th'] | False |
request_image_with_retrying | (**kwargs) |
Helper method to perform an image request to a running orca server process
with retrying logic.
|
Helper method to perform an image request to a running orca server process
with retrying logic.
| def request_image_with_retrying(**kwargs):
"""
Helper method to perform an image request to a running orca server process
with retrying logic.
"""
from requests import post
if config.server_url:
server_url = config.server_url
else:
server_url = "http://{hostname}:{port}".for... | [
"def",
"request_image_with_retrying",
"(",
"*",
"*",
"kwargs",
")",
":",
"from",
"requests",
"import",
"post",
"if",
"config",
".",
"server_url",
":",
"server_url",
"=",
"config",
".",
"server_url",
"else",
":",
"server_url",
"=",
"\"http://{hostname}:{port}\"",
... | [
1454,
0
] | [
1478,
19
] | python | en | ['en', 'error', 'th'] | False |
to_image | (fig, format=None, width=None, height=None, scale=None, validate=True) |
Convert a figure to a static image bytes string
Parameters
----------
fig:
Figure object or dict representing a figure
format: str or None
The desired image format. One of
- 'png'
- 'jpg' or 'jpeg'
- 'webp'
- 'svg'
- 'pdf'
... |
Convert a figure to a static image bytes string | def to_image(fig, format=None, width=None, height=None, scale=None, validate=True):
"""
Convert a figure to a static image bytes string
Parameters
----------
fig:
Figure object or dict representing a figure
format: str or None
The desired image format. One of
- 'png'
... | [
"def",
"to_image",
"(",
"fig",
",",
"format",
"=",
"None",
",",
"width",
"=",
"None",
",",
"height",
"=",
"None",
",",
"scale",
"=",
"None",
",",
"validate",
"=",
"True",
")",
":",
"# Make sure orca sever is running",
"# -------------------------------",
"ensu... | [
1481,
0
] | [
1678,
37
] | python | en | ['en', 'error', 'th'] | False |
write_image | (
fig, file, format=None, scale=None, width=None, height=None, validate=True
) |
Convert a figure to a static image and write it to a file or writeable
object
Parameters
----------
fig:
Figure object or dict representing a figure
file: str or writeable
A string representing a local file path or a writeable object
(e.g. an open file descriptor)
... |
Convert a figure to a static image and write it to a file or writeable
object | def write_image(
fig, file, format=None, scale=None, width=None, height=None, validate=True
):
"""
Convert a figure to a static image and write it to a file or writeable
object
Parameters
----------
fig:
Figure object or dict representing a figure
file: str or writeable
... | [
"def",
"write_image",
"(",
"fig",
",",
"file",
",",
"format",
"=",
"None",
",",
"scale",
"=",
"None",
",",
"width",
"=",
"None",
",",
"height",
"=",
"None",
",",
"validate",
"=",
"True",
")",
":",
"# Check if file is a string",
"# -------------------------",... | [
1681,
0
] | [
1778,
28
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.restore_defaults | (self, reset_server=True) |
Reset all orca configuration properties to their default values
|
Reset all orca configuration properties to their default values
| def restore_defaults(self, reset_server=True):
"""
Reset all orca configuration properties to their default values
"""
self._props = {}
if reset_server:
# Server must restart before setting is active
reset_status() | [
"def",
"restore_defaults",
"(",
"self",
",",
"reset_server",
"=",
"True",
")",
":",
"self",
".",
"_props",
"=",
"{",
"}",
"if",
"reset_server",
":",
"# Server must restart before setting is active",
"reset_status",
"(",
")"
] | [
238,
4
] | [
246,
26
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.update | (self, d={}, **kwargs) |
Update one or more properties from a dict or from input keyword
arguments.
Parameters
----------
d: dict
Dictionary from property names to new property values.
kwargs
Named argument value pairs where the name is a configuration
prope... |
Update one or more properties from a dict or from input keyword
arguments. | def update(self, d={}, **kwargs):
"""
Update one or more properties from a dict or from input keyword
arguments.
Parameters
----------
d: dict
Dictionary from property names to new property values.
kwargs
Named argument value pairs where ... | [
"def",
"update",
"(",
"self",
",",
"d",
"=",
"{",
"}",
",",
"*",
"*",
"kwargs",
")",
":",
"# Combine d and kwargs",
"if",
"not",
"isinstance",
"(",
"d",
",",
"dict",
")",
":",
"raise",
"ValueError",
"(",
"\"\"\"\nThe first argument to update must be a dict, \\... | [
248,
4
] | [
298,
31
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.reload | (self, warn=True) |
Reload orca settings from ~/.plotly/.orca, if any.
Note: Settings are loaded automatically when plotly is imported.
This method is only needed if the setting are changed by some outside
process (e.g. a text editor) during an interactive session.
Parameters
----------
... |
Reload orca settings from ~/.plotly/.orca, if any. | def reload(self, warn=True):
"""
Reload orca settings from ~/.plotly/.orca, if any.
Note: Settings are loaded automatically when plotly is imported.
This method is only needed if the setting are changed by some outside
process (e.g. a text editor) during an interactive session.
... | [
"def",
"reload",
"(",
"self",
",",
"warn",
"=",
"True",
")",
":",
"if",
"os",
".",
"path",
".",
"exists",
"(",
"self",
".",
"config_file",
")",
":",
"# ### Load file into a string ###",
"try",
":",
"with",
"open",
"(",
"self",
".",
"config_file",
",",
... | [
300,
4
] | [
357,
13
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.save | (self) |
Attempt to save current settings to disk, so that they are
automatically restored for future sessions.
This operation requires write access to the path returned by
in the `config_file` property.
Returns
-------
None
|
Attempt to save current settings to disk, so that they are
automatically restored for future sessions. | def save(self):
"""
Attempt to save current settings to disk, so that they are
automatically restored for future sessions.
This operation requires write access to the path returned by
in the `config_file` property.
Returns
-------
None
"""
... | [
"def",
"save",
"(",
"self",
")",
":",
"if",
"ensure_writable_plotly_dir",
"(",
")",
":",
"with",
"open",
"(",
"self",
".",
"config_file",
",",
"\"w\"",
")",
"as",
"f",
":",
"json",
".",
"dump",
"(",
"self",
".",
"_props",
",",
"f",
",",
"indent",
"... | [
359,
4
] | [
380,
13
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.server_url | (self) |
The server URL to use for an external orca server, or None if orca
should be managed locally
Overrides executable, port, timeout, mathjax, topojson,
and mapbox_access_token
Returns
-------
str or None
|
The server URL to use for an external orca server, or None if orca
should be managed locally | def server_url(self):
"""
The server URL to use for an external orca server, or None if orca
should be managed locally
Overrides executable, port, timeout, mathjax, topojson,
and mapbox_access_token
Returns
-------
str or None
"""
return ... | [
"def",
"server_url",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
".",
"get",
"(",
"\"server_url\"",
",",
"None",
")"
] | [
383,
4
] | [
395,
50
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.port | (self) |
The specific port to use to communicate with the orca server, or
None if the port is to be chosen automatically.
If an orca server is active, the port in use is stored in the
plotly.io.orca.status.port property.
Returns
-------
int or None
|
The specific port to use to communicate with the orca server, or
None if the port is to be chosen automatically. | def port(self):
"""
The specific port to use to communicate with the orca server, or
None if the port is to be chosen automatically.
If an orca server is active, the port in use is stored in the
plotly.io.orca.status.port property.
Returns
-------
int or... | [
"def",
"port",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
".",
"get",
"(",
"\"port\"",
",",
"None",
")"
] | [
425,
4
] | [
437,
44
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.executable | (self) |
The name or full path of the orca executable.
- If a name (e.g. 'orca'), then it should be the name of an orca
executable on the PATH. The directories on the PATH can be
displayed by running the following command:
>>> import os
>>> print(os.environ.get('PA... |
The name or full path of the orca executable. | def executable(self):
"""
The name or full path of the orca executable.
- If a name (e.g. 'orca'), then it should be the name of an orca
executable on the PATH. The directories on the PATH can be
displayed by running the following command:
>>> import os
... | [
"def",
"executable",
"(",
"self",
")",
":",
"executable_list",
"=",
"self",
".",
"_props",
".",
"get",
"(",
"\"executable_list\"",
",",
"[",
"\"orca\"",
"]",
")",
"if",
"executable_list",
"is",
"None",
":",
"return",
"None",
"else",
":",
"return",
"\" \"",... | [
457,
4
] | [
484,
44
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.timeout | (self) |
The number of seconds of inactivity required before the orca server
is shut down.
For example, if timeout is set to 20, then the orca
server will shutdown once is has not been used for at least
20 seconds. If timeout is set to None, then the server will not be
automatic... |
The number of seconds of inactivity required before the orca server
is shut down. | def timeout(self):
"""
The number of seconds of inactivity required before the orca server
is shut down.
For example, if timeout is set to 20, then the orca
server will shutdown once is has not been used for at least
20 seconds. If timeout is set to None, then the server... | [
"def",
"timeout",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
".",
"get",
"(",
"\"timeout\"",
",",
"None",
")"
] | [
508,
4
] | [
528,
47
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.default_width | (self) |
The default width to use on image export. This value is only
applied if no width value is supplied to the plotly.io
to_image or write_image functions.
Returns
-------
int or None
|
The default width to use on image export. This value is only
applied if no width value is supplied to the plotly.io
to_image or write_image functions. | def default_width(self):
"""
The default width to use on image export. This value is only
applied if no width value is supplied to the plotly.io
to_image or write_image functions.
Returns
-------
int or None
"""
return self._props.get("default_wid... | [
"def",
"default_width",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
".",
"get",
"(",
"\"default_width\"",
",",
"None",
")"
] | [
550,
4
] | [
560,
53
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.default_height | (self) |
The default height to use on image export. This value is only
applied if no height value is supplied to the plotly.io
to_image or write_image functions.
Returns
-------
int or None
|
The default height to use on image export. This value is only
applied if no height value is supplied to the plotly.io
to_image or write_image functions. | def default_height(self):
"""
The default height to use on image export. This value is only
applied if no height value is supplied to the plotly.io
to_image or write_image functions.
Returns
-------
int or None
"""
return self._props.get("default_... | [
"def",
"default_height",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
".",
"get",
"(",
"\"default_height\"",
",",
"None",
")"
] | [
579,
4
] | [
589,
54
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.default_format | (self) |
The default image format to use on image export.
Valid image formats strings are:
- 'png'
- 'jpg' or 'jpeg'
- 'webp'
- 'svg'
- 'pdf'
- 'eps' (Requires the poppler library to be installed)
This value is only applied if no format value... |
The default image format to use on image export. | def default_format(self):
"""
The default image format to use on image export.
Valid image formats strings are:
- 'png'
- 'jpg' or 'jpeg'
- 'webp'
- 'svg'
- 'pdf'
- 'eps' (Requires the poppler library to be installed)
This val... | [
"def",
"default_format",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
".",
"get",
"(",
"\"default_format\"",
",",
"\"png\"",
")"
] | [
608,
4
] | [
627,
55
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.default_scale | (self) |
The default image scaling factor to use on image export.
This value is only applied if no scale value is supplied to the
plotly.io to_image or write_image functions.
Returns
-------
int or None
|
The default image scaling factor to use on image export.
This value is only applied if no scale value is supplied to the
plotly.io to_image or write_image functions. | def default_scale(self):
"""
The default image scaling factor to use on image export.
This value is only applied if no scale value is supplied to the
plotly.io to_image or write_image functions.
Returns
-------
int or None
"""
return self._props.g... | [
"def",
"default_scale",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
".",
"get",
"(",
"\"default_scale\"",
",",
"1",
")"
] | [
639,
4
] | [
649,
50
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.topojson | (self) |
Path to the topojson files needed to render choropleth traces.
If None, topojson files from the plot.ly CDN are used.
Returns
-------
str
|
Path to the topojson files needed to render choropleth traces. | def topojson(self):
"""
Path to the topojson files needed to render choropleth traces.
If None, topojson files from the plot.ly CDN are used.
Returns
-------
str
"""
return self._props.get("topojson", None) | [
"def",
"topojson",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
".",
"get",
"(",
"\"topojson\"",
",",
"None",
")"
] | [
668,
4
] | [
678,
48
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.mathjax | (self) |
Path to the MathJax bundle needed to render LaTeX characters
Returns
-------
str
|
Path to the MathJax bundle needed to render LaTeX characters | def mathjax(self):
"""
Path to the MathJax bundle needed to render LaTeX characters
Returns
-------
str
"""
return self._props.get(
"mathjax",
("https://cdnjs.cloudflare.com" "/ajax/libs/mathjax/2.7.5/MathJax.js"),
) | [
"def",
"mathjax",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
".",
"get",
"(",
"\"mathjax\"",
",",
"(",
"\"https://cdnjs.cloudflare.com\"",
"\"/ajax/libs/mathjax/2.7.5/MathJax.js\"",
")",
",",
")"
] | [
700,
4
] | [
711,
9
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.mapbox_access_token | (self) |
Mapbox access token required to render mapbox traces.
Returns
-------
str
|
Mapbox access token required to render mapbox traces. | def mapbox_access_token(self):
"""
Mapbox access token required to render mapbox traces.
Returns
-------
str
"""
return self._props.get("mapbox_access_token", None) | [
"def",
"mapbox_access_token",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
".",
"get",
"(",
"\"mapbox_access_token\"",
",",
"None",
")"
] | [
733,
4
] | [
741,
59
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.plotlyjs | (self) |
The plotly.js bundle being used for image rendering.
Returns
-------
str
|
The plotly.js bundle being used for image rendering. | def plotlyjs(self):
"""
The plotly.js bundle being used for image rendering.
Returns
-------
str
"""
return self._constants.get("plotlyjs", None) | [
"def",
"plotlyjs",
"(",
"self",
")",
":",
"return",
"self",
".",
"_constants",
".",
"get",
"(",
"\"plotlyjs\"",
",",
"None",
")"
] | [
789,
4
] | [
797,
52
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.config_file | (self) |
Path to orca configuration file
Using the `plotly.io.config.save()` method will save the current
configuration settings to this file. Settings in this file are
restored at the beginning of each sessions.
Returns
-------
str
|
Path to orca configuration file | def config_file(self):
"""
Path to orca configuration file
Using the `plotly.io.config.save()` method will save the current
configuration settings to this file. Settings in this file are
restored at the beginning of each sessions.
Returns
-------
str
... | [
"def",
"config_file",
"(",
"self",
")",
":",
"return",
"os",
".",
"path",
".",
"join",
"(",
"PLOTLY_DIR",
",",
"\".orca\"",
")"
] | [
800,
4
] | [
812,
48
] | python | en | ['en', 'error', 'th'] | False |
OrcaConfig.__repr__ | (self) |
Display a nice representation of the current orca configuration.
|
Display a nice representation of the current orca configuration.
| def __repr__(self):
"""
Display a nice representation of the current orca configuration.
"""
return """\
orca configuration
------------------
server_url: {server_url}
executable: {executable}
port: {port}
timeout: {timeout}
default_width: {default_width}
default_... | [
"def",
"__repr__",
"(",
"self",
")",
":",
"return",
"\"\"\"\\\norca configuration\n------------------\n server_url: {server_url}\n executable: {executable}\n port: {port}\n timeout: {timeout}\n default_width: {default_width}\n default_height: {default_height}\n default_scale: {def... | [
814,
4
] | [
854,
9
] | python | en | ['en', 'error', 'th'] | False |
OrcaStatus.state | (self) |
A string representing the state of the orca server process
One of:
- unvalidated: The orca executable has not yet been searched for or
tested to make sure its valid.
- validated: The orca executable has been located and tested for
validity, but it is not run... |
A string representing the state of the orca server process | def state(self):
"""
A string representing the state of the orca server process
One of:
- unvalidated: The orca executable has not yet been searched for or
tested to make sure its valid.
- validated: The orca executable has been located and tested for
... | [
"def",
"state",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
"[",
"\"state\"",
"]"
] | [
880,
4
] | [
891,
35
] | python | en | ['en', 'error', 'th'] | False |
OrcaStatus.executable | (self) |
If the `state` property is 'validated' or 'running', this property
contains the full path to the orca executable.
This path can be specified explicitly by setting the `executable`
property of the `plotly.io.orca.config` object.
This property will be None if the `state` is 'unv... |
If the `state` property is 'validated' or 'running', this property
contains the full path to the orca executable. | def executable(self):
"""
If the `state` property is 'validated' or 'running', this property
contains the full path to the orca executable.
This path can be specified explicitly by setting the `executable`
property of the `plotly.io.orca.config` object.
This property wi... | [
"def",
"executable",
"(",
"self",
")",
":",
"executable_list",
"=",
"self",
".",
"_props",
"[",
"\"executable_list\"",
"]",
"if",
"executable_list",
"is",
"None",
":",
"return",
"None",
"else",
":",
"return",
"\" \"",
".",
"join",
"(",
"executable_list",
")"... | [
894,
4
] | [
908,
44
] | python | en | ['en', 'error', 'th'] | False |
OrcaStatus.version | (self) |
If the `state` property is 'validated' or 'running', this property
contains the version of the validated orca executable.
This property will be None if the `state` is 'unvalidated'.
|
If the `state` property is 'validated' or 'running', this property
contains the version of the validated orca executable. | def version(self):
"""
If the `state` property is 'validated' or 'running', this property
contains the version of the validated orca executable.
This property will be None if the `state` is 'unvalidated'.
"""
return self._props["version"] | [
"def",
"version",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
"[",
"\"version\"",
"]"
] | [
911,
4
] | [
918,
37
] | python | en | ['en', 'error', 'th'] | False |
OrcaStatus.pid | (self) |
The process id of the orca server process, if any. This property
will be None if the `state` is not 'running'.
|
The process id of the orca server process, if any. This property
will be None if the `state` is not 'running'.
| def pid(self):
"""
The process id of the orca server process, if any. This property
will be None if the `state` is not 'running'.
"""
return self._props["pid"] | [
"def",
"pid",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
"[",
"\"pid\"",
"]"
] | [
921,
4
] | [
926,
33
] | python | en | ['en', 'error', 'th'] | False |
OrcaStatus.port | (self) |
The port number that the orca server process is listening to, if any.
This property will be None if the `state` is not 'running'.
This port can be specified explicitly by setting the `port`
property of the `plotly.io.orca.config` object.
|
The port number that the orca server process is listening to, if any.
This property will be None if the `state` is not 'running'. | def port(self):
"""
The port number that the orca server process is listening to, if any.
This property will be None if the `state` is not 'running'.
This port can be specified explicitly by setting the `port`
property of the `plotly.io.orca.config` object.
"""
r... | [
"def",
"port",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
"[",
"\"port\"",
"]"
] | [
929,
4
] | [
937,
34
] | python | en | ['en', 'error', 'th'] | False |
OrcaStatus.command | (self) |
The command arguments used to launch the running orca server, if any.
This property will be None if the `state` is not 'running'.
|
The command arguments used to launch the running orca server, if any.
This property will be None if the `state` is not 'running'.
| def command(self):
"""
The command arguments used to launch the running orca server, if any.
This property will be None if the `state` is not 'running'.
"""
return self._props["command"] | [
"def",
"command",
"(",
"self",
")",
":",
"return",
"self",
".",
"_props",
"[",
"\"command\"",
"]"
] | [
940,
4
] | [
945,
37
] | python | en | ['en', 'error', 'th'] | False |
OrcaStatus.__repr__ | (self) |
Display a nice representation of the current orca server status.
|
Display a nice representation of the current orca server status.
| def __repr__(self):
"""
Display a nice representation of the current orca server status.
"""
return """\
orca status
-----------
state: {state}
executable: {executable}
version: {version}
port: {port}
pid: {pid}
command: {command}
""".format(
executab... | [
"def",
"__repr__",
"(",
"self",
")",
":",
"return",
"\"\"\"\\\norca status\n-----------\n state: {state}\n executable: {executable}\n version: {version}\n port: {port}\n pid: {pid}\n command: {command}\n\n\"\"\"",
".",
"format",
"(",
"executable",
"=",
"self",
".",
"e... | [
947,
4
] | [
968,
9
] | python | en | ['en', 'error', 'th'] | False |
setup | (bot) |
Mandatory function to add the Cog to the bot.
|
Mandatory function to add the Cog to the bot.
| def setup(bot):
"""
Mandatory function to add the Cog to the bot.
"""
bot.add_cog(GiveAwayCog(bot)) | [
"def",
"setup",
"(",
"bot",
")",
":",
"bot",
".",
"add_cog",
"(",
"GiveAwayCog",
"(",
"bot",
")",
")"
] | [
355,
0
] | [
359,
33
] | python | en | ['en', 'error', 'th'] | False |
create | (body) |
Create a new grid.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
|
Create a new grid. | def create(body):
"""
Create a new grid.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE)
return request("post", url, json=body) | [
"def",
"create",
"(",
"body",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
")",
"return",
"request",
"(",
"\"post\"",
",",
"url",
",",
"json",
"=",
"body",
")"
] | [
8,
0
] | [
17,
42
] | python | en | ['en', 'error', 'th'] | False |
retrieve | (fid, share_key=None) |
Retrieve a grid from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:returns: (requests.Response) Returns response directly from requests.
|
Retrieve a grid from Plotly. | def retrieve(fid, share_key=None):
"""
Retrieve a grid from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:returns: (requests.Response) Returns response directly from requests.
"""
u... | [
"def",
"retrieve",
"(",
"fid",
",",
"share_key",
"=",
"None",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
")",
"params",
"=",
"make_params",
"(",
"share_key",
"=",
"share_key",
")",
"return",
"request",
"(",
"\"get\"",
",... | [
20,
0
] | [
31,
45
] | python | en | ['en', 'error', 'th'] | False |
content | (fid, share_key=None) |
Retrieve full content for the grid (normal retrieve only yields preview)
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:returns: (requests.Response) Returns response directly from requests.
|
Retrieve full content for the grid (normal retrieve only yields preview) | def content(fid, share_key=None):
"""
Retrieve full content for the grid (normal retrieve only yields preview)
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:returns: (requests.Response) Returns resp... | [
"def",
"content",
"(",
"fid",
",",
"share_key",
"=",
"None",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
",",
"route",
"=",
"\"content\"",
")",
"params",
"=",
"make_params",
"(",
"share_key",
"=",
"share_key",
")",
"retur... | [
34,
0
] | [
45,
45
] | python | en | ['en', 'error', 'th'] | False |
update | (fid, body) |
Update a grid from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
|
Update a grid from Plotly. | def update(fid, body):
"""
Update a grid from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id... | [
"def",
"update",
"(",
"fid",
",",
"body",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
")",
"return",
"request",
"(",
"\"put\"",
",",
"url",
",",
"json",
"=",
"body",
")"
] | [
48,
0
] | [
58,
41
] | python | en | ['en', 'error', 'th'] | False |
trash | (fid) |
Soft-delete a grid from Plotly. (Can be undone with 'restore').
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
|
Soft-delete a grid from Plotly. (Can be undone with 'restore'). | def trash(fid):
"""
Soft-delete a grid from Plotly. (Can be undone with 'restore').
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route="trash")
return req... | [
"def",
"trash",
"(",
"fid",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
",",
"route",
"=",
"\"trash\"",
")",
"return",
"request",
"(",
"\"post\"",
",",
"url",
")"
] | [
61,
0
] | [
70,
31
] | python | en | ['en', 'error', 'th'] | False |
restore | (fid) |
Restore a trashed grid from Plotly. See 'trash'.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
|
Restore a trashed grid from Plotly. See 'trash'. | def restore(fid):
"""
Restore a trashed grid from Plotly. See 'trash'.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route="restore")
return request("post"... | [
"def",
"restore",
"(",
"fid",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
",",
"route",
"=",
"\"restore\"",
")",
"return",
"request",
"(",
"\"post\"",
",",
"url",
")"
] | [
73,
0
] | [
82,
31
] | python | en | ['en', 'error', 'th'] | False |
permanent_delete | (fid) |
Permanently delete a trashed grid file from Plotly. See 'trash'.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
|
Permanently delete a trashed grid file from Plotly. See 'trash'. | def permanent_delete(fid):
"""
Permanently delete a trashed grid file from Plotly. See 'trash'.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route="permanent_... | [
"def",
"permanent_delete",
"(",
"fid",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
",",
"route",
"=",
"\"permanent_delete\"",
")",
"return",
"request",
"(",
"\"delete\"",
",",
"url",
")"
] | [
85,
0
] | [
94,
33
] | python | en | ['en', 'error', 'th'] | False |
destroy | (fid) |
Permanently delete a grid file from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
|
Permanently delete a grid file from Plotly. | def destroy(fid):
"""
Permanently delete a grid file from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid)
return request("delete", url) | [
"def",
"destroy",
"(",
"fid",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
")",
"return",
"request",
"(",
"\"delete\"",
",",
"url",
")"
] | [
97,
0
] | [
106,
33
] | python | en | ['en', 'error', 'th'] | False |
lookup | (path, parent=None, user=None, exists=None) |
Retrieve a grid file from Plotly without needing a fid.
:param (str) path: The '/'-delimited path specifying the file location.
:param (int) parent: Parent id, an integer, which the path is relative to.
:param (str) user: The username to target files for. Defaults to requestor.
:param (bool) exist... |
Retrieve a grid file from Plotly without needing a fid. | def lookup(path, parent=None, user=None, exists=None):
"""
Retrieve a grid file from Plotly without needing a fid.
:param (str) path: The '/'-delimited path specifying the file location.
:param (int) parent: Parent id, an integer, which the path is relative to.
:param (str) user: The username to ta... | [
"def",
"lookup",
"(",
"path",
",",
"parent",
"=",
"None",
",",
"user",
"=",
"None",
",",
"exists",
"=",
"None",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"route",
"=",
"\"lookup\"",
")",
"params",
"=",
"make_params",
"(",
"path",
"=",
... | [
109,
0
] | [
122,
45
] | python | en | ['en', 'error', 'th'] | False |
col_create | (fid, body) |
Create a new column (or columns) inside a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
|
Create a new column (or columns) inside a grid. | def col_create(fid, body):
"""
Create a new column (or columns) inside a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url... | [
"def",
"col_create",
"(",
"fid",
",",
"body",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
",",
"route",
"=",
"\"col\"",
")",
"return",
"request",
"(",
"\"post\"",
",",
"url",
",",
"json",
"=",
"body",
")"
] | [
125,
0
] | [
135,
42
] | python | en | ['en', 'error', 'th'] | False |
col_retrieve | (fid, uid) |
Retrieve a column (or columns) from a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) uid: A ','-concatenated string of column uids in the grid.
:returns: (requests.Response) Returns response directly from requests.
|
Retrieve a column (or columns) from a grid. | def col_retrieve(fid, uid):
"""
Retrieve a column (or columns) from a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) uid: A ','-concatenated string of column uids in the grid.
:returns: (requests.Response) Returns response directly from requests.
"""... | [
"def",
"col_retrieve",
"(",
"fid",
",",
"uid",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
",",
"route",
"=",
"\"col\"",
")",
"params",
"=",
"make_params",
"(",
"uid",
"=",
"uid",
")",
"return",
"request",
"(",
"\"get\"... | [
138,
0
] | [
149,
45
] | python | en | ['en', 'error', 'th'] | False |
col_update | (fid, uid, body) |
Update a column (or columns) from a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) uid: A ','-concatenated string of column uids in the grid.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response dire... |
Update a column (or columns) from a grid. | def col_update(fid, uid, body):
"""
Update a column (or columns) from a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) uid: A ','-concatenated string of column uids in the grid.
:param (dict) body: A mapping of body param names to values.
:returns: (r... | [
"def",
"col_update",
"(",
"fid",
",",
"uid",
",",
"body",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
",",
"route",
"=",
"\"col\"",
")",
"params",
"=",
"make_params",
"(",
"uid",
"=",
"uid",
")",
"return",
"request",
... | [
152,
0
] | [
164,
56
] | python | en | ['en', 'error', 'th'] | False |
col_delete | (fid, uid) |
Permanently delete a column (or columns) from a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) uid: A ','-concatenated string of column uids in the grid.
:returns: (requests.Response) Returns response directly from requests.
|
Permanently delete a column (or columns) from a grid. | def col_delete(fid, uid):
"""
Permanently delete a column (or columns) from a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) uid: A ','-concatenated string of column uids in the grid.
:returns: (requests.Response) Returns response directly from requests.
... | [
"def",
"col_delete",
"(",
"fid",
",",
"uid",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
",",
"route",
"=",
"\"col\"",
")",
"params",
"=",
"make_params",
"(",
"uid",
"=",
"uid",
")",
"return",
"request",
"(",
"\"delete\... | [
167,
0
] | [
178,
48
] | python | en | ['en', 'error', 'th'] | False |
row | (fid, body) |
Append rows to a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
|
Append rows to a grid. | def row(fid, body):
"""
Append rows to a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, r... | [
"def",
"row",
"(",
"fid",
",",
"body",
")",
":",
"url",
"=",
"build_url",
"(",
"RESOURCE",
",",
"id",
"=",
"fid",
",",
"route",
"=",
"\"row\"",
")",
"return",
"request",
"(",
"\"post\"",
",",
"url",
",",
"json",
"=",
"body",
")"
] | [
181,
0
] | [
191,
42
] | python | en | ['en', 'error', 'th'] | False |
Textfont.color | (self) |
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
- A named CSS color:
... |
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
- A named CSS color:
... | def color(self):
"""
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
- A name... | [
"def",
"color",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"color\"",
"]"
] | [
15,
4
] | [
64,
28
] | python | en | ['en', 'error', 'th'] | False |
Textfont.colorsrc | (self) |
Sets the source reference on Chart Studio Cloud for color .
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
|
Sets the source reference on Chart Studio Cloud for color .
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["colorsrc"] | [
"def",
"colorsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"colorsrc\"",
"]"
] | [
73,
4
] | [
84,
31
] | python | en | ['en', 'error', 'th'] | False |
Textfont.family | (self) |
HTML font family - the typeface that will be applied by the web
browser. The web browser will only be able to apply a font if
it is available on the system which it operates. Provide
multiple font families, separated by commas, to indicate the
preference in which to apply fonts ... |
HTML font family - the typeface that will be applied by the web
browser. The web browser will only be able to apply a font if
it is available on the system which it operates. Provide
multiple font families, separated by commas, to indicate the
preference in which to apply fonts ... | def family(self):
"""
HTML font family - the typeface that will be applied by the web
browser. The web browser will only be able to apply a font if
it is available on the system which it operates. Provide
multiple font families, separated by commas, to indicate the
prefer... | [
"def",
"family",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"family\"",
"]"
] | [
93,
4
] | [
116,
29
] | python | en | ['en', 'error', 'th'] | False |
Textfont.familysrc | (self) |
Sets the source reference on Chart Studio Cloud for family .
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
|
Sets the source reference on Chart Studio Cloud for family .
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["familysrc"] | [
"def",
"familysrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"familysrc\"",
"]"
] | [
125,
4
] | [
136,
32
] | python | en | ['en', 'error', 'th'] | False |
Textfont.size | (self) |
The 'size' property is a number and may be specified as:
- An int or float in the interval [1, inf]
- A tuple, list, or one-dimensional numpy array of the above
Returns
-------
int|float|numpy.ndarray
|
The 'size' property is a number and may be specified as:
- An int or float in the interval [1, inf]
- A tuple, list, or one-dimensional numpy array of the above | def size(self):
"""
The 'size' property is a number and may be specified as:
- An int or float in the interval [1, inf]
- A tuple, list, or one-dimensional numpy array of the above
Returns
-------
int|float|numpy.ndarray
"""
return self["size"... | [
"def",
"size",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"size\"",
"]"
] | [
145,
4
] | [
155,
27
] | python | en | ['en', 'error', 'th'] | False |
Textfont.sizesrc | (self) |
Sets the source reference on Chart Studio Cloud for size .
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
|
Sets the source reference on Chart Studio Cloud for size .
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["sizesrc"] | [
"def",
"sizesrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"sizesrc\"",
"]"
] | [
164,
4
] | [
175,
30
] | python | en | ['en', 'error', 'th'] | False |
Textfont.__init__ | (
self,
arg=None,
color=None,
colorsrc=None,
family=None,
familysrc=None,
size=None,
sizesrc=None,
**kwargs
) |
Construct a new Textfont object
Sets the font used inside `pathbar`.
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.treemap.pathbar.Textfont`
color
... |
Construct a new Textfont object
Sets the font used inside `pathbar`. | def __init__(
self,
arg=None,
color=None,
colorsrc=None,
family=None,
familysrc=None,
size=None,
sizesrc=None,
**kwargs
):
"""
Construct a new Textfont object
Sets the font used inside `pathbar`.
Parame... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"color",
"=",
"None",
",",
"colorsrc",
"=",
"None",
",",
"family",
"=",
"None",
",",
"familysrc",
"=",
"None",
",",
"size",
"=",
"None",
",",
"sizesrc",
"=",
"None",
",",
"*",
"*",
"kw... | [
215,
4
] | [
329,
34
] | python | en | ['en', 'error', 'th'] | False |
HttpTransport.__init__ | (self) | Initialize an `HttpTransport` instance. | Initialize an `HttpTransport` instance. | def __init__(self) -> None:
"""Initialize an `HttpTransport` instance."""
super(HttpTransport, self).__init__()
self.client_session: ClientSession = None
self.connector: TCPConnector = None
self.logger = logging.getLogger(__name__) | [
"def",
"__init__",
"(",
"self",
")",
"->",
"None",
":",
"super",
"(",
"HttpTransport",
",",
"self",
")",
".",
"__init__",
"(",
")",
"self",
".",
"client_session",
":",
"ClientSession",
"=",
"None",
"self",
".",
"connector",
":",
"TCPConnector",
"=",
"Non... | [
17,
4
] | [
22,
49
] | python | en | ['en', 'lb', 'it'] | False |
HttpTransport.start | (self) | Start the transport. | Start the transport. | async def start(self):
"""Start the transport."""
session_args = {}
self.connector = TCPConnector(limit=200, limit_per_host=50)
if self.collector:
session_args["trace_configs"] = [
StatsTracer(self.collector, "outbound-http:")
]
session_arg... | [
"async",
"def",
"start",
"(",
"self",
")",
":",
"session_args",
"=",
"{",
"}",
"self",
".",
"connector",
"=",
"TCPConnector",
"(",
"limit",
"=",
"200",
",",
"limit_per_host",
"=",
"50",
")",
"if",
"self",
".",
"collector",
":",
"session_args",
"[",
"\"... | [
24,
4
] | [
35,
19
] | python | en | ['en', 'no', 'en'] | True |
HttpTransport.stop | (self) | Stop the transport. | Stop the transport. | async def stop(self):
"""Stop the transport."""
await self.client_session.close()
self.client_session = None | [
"async",
"def",
"stop",
"(",
"self",
")",
":",
"await",
"self",
".",
"client_session",
".",
"close",
"(",
")",
"self",
".",
"client_session",
"=",
"None"
] | [
37,
4
] | [
40,
34
] | python | en | ['en', 'en', 'en'] | True |
HttpTransport.handle_message | (self, payload: Union[str, bytes], endpoint: str) |
Handle message from queue.
Args:
message: `OutboundMessage` to send over transport implementation
|
Handle message from queue. | async def handle_message(self, payload: Union[str, bytes], endpoint: str):
"""
Handle message from queue.
Args:
message: `OutboundMessage` to send over transport implementation
"""
if not endpoint:
raise OutboundTransportError("No endpoint provided")
... | [
"async",
"def",
"handle_message",
"(",
"self",
",",
"payload",
":",
"Union",
"[",
"str",
",",
"bytes",
"]",
",",
"endpoint",
":",
"str",
")",
":",
"if",
"not",
"endpoint",
":",
"raise",
"OutboundTransportError",
"(",
"\"No endpoint provided\"",
")",
"headers... | [
42,
4
] | [
60,
74
] | python | en | ['en', 'error', 'th'] | False |
Polar.angularaxis | (self) |
The 'angularaxis' property is an instance of AngularAxis
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.polar.AngularAxis`
- A dict of string/value properties that will be passed
to the AngularAxis constructor
Supported dict ... |
The 'angularaxis' property is an instance of AngularAxis
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.polar.AngularAxis`
- A dict of string/value properties that will be passed
to the AngularAxis constructor
Supported dict ... | def angularaxis(self):
"""
The 'angularaxis' property is an instance of AngularAxis
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.polar.AngularAxis`
- A dict of string/value properties that will be passed
to the AngularAxis constructo... | [
"def",
"angularaxis",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"angularaxis\"",
"]"
] | [
26,
4
] | [
289,
34
] | python | en | ['en', 'error', 'th'] | False |
Polar.bargap | (self) |
Sets the gap between bars of adjacent location coordinates.
Values are unitless, they represent fractions of the minimum
difference in bar positions in the data.
The 'bargap' property is a number and may be specified as:
- An int or float in the interval [0, 1]
R... |
Sets the gap between bars of adjacent location coordinates.
Values are unitless, they represent fractions of the minimum
difference in bar positions in the data.
The 'bargap' property is a number and may be specified as:
- An int or float in the interval [0, 1] | def bargap(self):
"""
Sets the gap between bars of adjacent location coordinates.
Values are unitless, they represent fractions of the minimum
difference in bar positions in the data.
The 'bargap' property is a number and may be specified as:
- An int or float in t... | [
"def",
"bargap",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"bargap\"",
"]"
] | [
298,
4
] | [
311,
29
] | python | en | ['en', 'error', 'th'] | False |
Polar.barmode | (self) |
Determines how bars at the same location coordinate are
displayed on the graph. With "stack", the bars are stacked on
top of one another With "overlay", the bars are plotted over
one another, you might need to an "opacity" to see multiple
bars.
The 'barmode' propert... |
Determines how bars at the same location coordinate are
displayed on the graph. With "stack", the bars are stacked on
top of one another With "overlay", the bars are plotted over
one another, you might need to an "opacity" to see multiple
bars.
The 'barmode' propert... | def barmode(self):
"""
Determines how bars at the same location coordinate are
displayed on the graph. With "stack", the bars are stacked on
top of one another With "overlay", the bars are plotted over
one another, you might need to an "opacity" to see multiple
bars.
... | [
"def",
"barmode",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"barmode\"",
"]"
] | [
320,
4
] | [
336,
30
] | python | en | ['en', 'error', 'th'] | False |
Polar.bgcolor | (self) |
Set the background color of the subplot
The 'bgcolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,100%... |
Set the background color of the subplot
The 'bgcolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv/hsva string (e.g. 'hsv(0,100%... | def bgcolor(self):
"""
Set the background color of the subplot
The 'bgcolor' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
- An hsv... | [
"def",
"bgcolor",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"bgcolor\"",
"]"
] | [
345,
4
] | [
395,
30
] | python | en | ['en', 'error', 'th'] | False |
Polar.domain | (self) |
The 'domain' property is an instance of Domain
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.polar.Domain`
- A dict of string/value properties that will be passed
to the Domain constructor
Supported dict properties:
... |
The 'domain' property is an instance of Domain
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.polar.Domain`
- A dict of string/value properties that will be passed
to the Domain constructor
Supported dict properties:
... | def domain(self):
"""
The 'domain' property is an instance of Domain
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.polar.Domain`
- A dict of string/value properties that will be passed
to the Domain constructor
Suppor... | [
"def",
"domain",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"domain\"",
"]"
] | [
404,
4
] | [
432,
29
] | python | en | ['en', 'error', 'th'] | False |
Polar.gridshape | (self) |
Determines if the radial axis grid lines and angular axis line
are drawn as "circular" sectors or as "linear" (polygon)
sectors. Has an effect only when the angular axis has `type`
"category". Note that `radialaxis.angle` is snapped to the
angle of the closest vertex when `grids... |
Determines if the radial axis grid lines and angular axis line
are drawn as "circular" sectors or as "linear" (polygon)
sectors. Has an effect only when the angular axis has `type`
"category". Note that `radialaxis.angle` is snapped to the
angle of the closest vertex when `grids... | def gridshape(self):
"""
Determines if the radial axis grid lines and angular axis line
are drawn as "circular" sectors or as "linear" (polygon)
sectors. Has an effect only when the angular axis has `type`
"category". Note that `radialaxis.angle` is snapped to the
angle o... | [
"def",
"gridshape",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"gridshape\"",
"]"
] | [
441,
4
] | [
458,
32
] | python | en | ['en', 'error', 'th'] | False |
Polar.hole | (self) |
Sets the fraction of the radius to cut out of the polar
subplot.
The 'hole' property is a number and may be specified as:
- An int or float in the interval [0, 1]
Returns
-------
int|float
|
Sets the fraction of the radius to cut out of the polar
subplot.
The 'hole' property is a number and may be specified as:
- An int or float in the interval [0, 1] | def hole(self):
"""
Sets the fraction of the radius to cut out of the polar
subplot.
The 'hole' property is a number and may be specified as:
- An int or float in the interval [0, 1]
Returns
-------
int|float
"""
return self["hole"] | [
"def",
"hole",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"hole\"",
"]"
] | [
467,
4
] | [
479,
27
] | python | en | ['en', 'error', 'th'] | False |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.