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 |
|---|---|---|---|---|---|---|---|---|---|---|---|
Labelfont.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
] | [
63,
28
] | python | en | ['en', 'error', 'th'] | False |
Labelfont.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\"",
"]"
] | [
72,
4
] | [
94,
29
] | python | en | ['en', 'error', 'th'] | False |
Labelfont.size | (self) |
The 'size' property is a number and may be specified as:
- An int or float in the interval [1, inf]
Returns
-------
int|float
|
The 'size' property is a number and may be specified as:
- An int or float in the interval [1, inf] | def size(self):
"""
The 'size' property is a number and may be specified as:
- An int or float in the interval [1, inf]
Returns
-------
int|float
"""
return self["size"] | [
"def",
"size",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"size\"",
"]"
] | [
103,
4
] | [
112,
27
] | python | en | ['en', 'error', 'th'] | False |
Labelfont.__init__ | (self, arg=None, color=None, family=None, size=None, **kwargs) |
Construct a new Labelfont object
Sets the font for the `dimension` labels.
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.parcats.Labelfont`
color
... |
Construct a new Labelfont object
Sets the font for the `dimension` labels. | def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Labelfont object
Sets the font for the `dimension` labels.
Parameters
----------
arg
dict of properties compatible with this constructor or
an... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"color",
"=",
"None",
",",
"family",
"=",
"None",
",",
"size",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"super",
"(",
"Labelfont",
",",
"self",
")",
".",
"__init__",
"(",
"\"lab... | [
143,
4
] | [
226,
34
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.autocolorscale | (self) |
Determines whether the colorscale is a default palette
(`autocolorscale: true`) or the palette determined by
`colorscale`. In case `colorscale` is unspecified or
`autocolorscale` is true, the default palette will be chosen
according to whether numbers in the `color` array are a... |
Determines whether the colorscale is a default palette
(`autocolorscale: true`) or the palette determined by
`colorscale`. In case `colorscale` is unspecified or
`autocolorscale` is true, the default palette will be chosen
according to whether numbers in the `color` array are a... | def autocolorscale(self):
"""
Determines whether the colorscale is a default palette
(`autocolorscale: true`) or the palette determined by
`colorscale`. In case `colorscale` is unspecified or
`autocolorscale` is true, the default palette will be chosen
according to wheth... | [
"def",
"autocolorscale",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"autocolorscale\"",
"]"
] | [
66,
4
] | [
82,
37
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.cauto | (self) |
Determines whether or not the color domain is computed with
respect to the input data (here u/v/w norm) or the bounds set
in `cmin` and `cmax` Defaults to `false` when `cmin` and
`cmax` are set by the user.
The 'cauto' property must be specified as a bool
(either T... |
Determines whether or not the color domain is computed with
respect to the input data (here u/v/w norm) or the bounds set
in `cmin` and `cmax` Defaults to `false` when `cmin` and
`cmax` are set by the user.
The 'cauto' property must be specified as a bool
(either T... | def cauto(self):
"""
Determines whether or not the color domain is computed with
respect to the input data (here u/v/w norm) or the bounds set
in `cmin` and `cmax` Defaults to `false` when `cmin` and
`cmax` are set by the user.
The 'cauto' property must be specified... | [
"def",
"cauto",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"cauto\"",
"]"
] | [
91,
4
] | [
105,
28
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.cmax | (self) |
Sets the upper bound of the color domain. Value should have the
same units as u/v/w norm and if set, `cmin` must be set as
well.
The 'cmax' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
|
Sets the upper bound of the color domain. Value should have the
same units as u/v/w norm and if set, `cmin` must be set as
well.
The 'cmax' property is a number and may be specified as:
- An int or float | def cmax(self):
"""
Sets the upper bound of the color domain. Value should have the
same units as u/v/w norm and if set, `cmin` must be set as
well.
The 'cmax' property is a number and may be specified as:
- An int or float
Returns
-------
... | [
"def",
"cmax",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"cmax\"",
"]"
] | [
114,
4
] | [
127,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.cmid | (self) |
Sets the mid-point of the color domain by scaling `cmin` and/or
`cmax` to be equidistant to this point. Value should have the
same units as u/v/w norm. Has no effect when `cauto` is
`false`.
The 'cmid' property is a number and may be specified as:
- An int or floa... |
Sets the mid-point of the color domain by scaling `cmin` and/or
`cmax` to be equidistant to this point. Value should have the
same units as u/v/w norm. Has no effect when `cauto` is
`false`.
The 'cmid' property is a number and may be specified as:
- An int or floa... | def cmid(self):
"""
Sets the mid-point of the color domain by scaling `cmin` and/or
`cmax` to be equidistant to this point. Value should have the
same units as u/v/w norm. Has no effect when `cauto` is
`false`.
The 'cmid' property is a number and may be specified as:... | [
"def",
"cmid",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"cmid\"",
"]"
] | [
136,
4
] | [
150,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.cmin | (self) |
Sets the lower bound of the color domain. Value should have the
same units as u/v/w norm and if set, `cmax` must be set as
well.
The 'cmin' property is a number and may be specified as:
- An int or float
Returns
-------
int|float
|
Sets the lower bound of the color domain. Value should have the
same units as u/v/w norm and if set, `cmax` must be set as
well.
The 'cmin' property is a number and may be specified as:
- An int or float | def cmin(self):
"""
Sets the lower bound of the color domain. Value should have the
same units as u/v/w norm and if set, `cmax` must be set as
well.
The 'cmin' property is a number and may be specified as:
- An int or float
Returns
-------
... | [
"def",
"cmin",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"cmin\"",
"]"
] | [
159,
4
] | [
172,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.coloraxis | (self) |
Sets a reference to a shared color axis. References to these
shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
etc. Settings for these shared color axes are set in the
layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
Note that multiple color scales can be... |
Sets a reference to a shared color axis. References to these
shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
etc. Settings for these shared color axes are set in the
layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
Note that multiple color scales can be... | def coloraxis(self):
"""
Sets a reference to a shared color axis. References to these
shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
etc. Settings for these shared color axes are set in the
layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
Note t... | [
"def",
"coloraxis",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"coloraxis\"",
"]"
] | [
181,
4
] | [
199,
32
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.colorbar | (self) |
The 'colorbar' property is an instance of ColorBar
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.ColorBar`
- A dict of string/value properties that will be passed
to the ColorBar constructor
Supported dict properties:
... |
The 'colorbar' property is an instance of ColorBar
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.ColorBar`
- A dict of string/value properties that will be passed
to the ColorBar constructor
Supported dict properties:
... | def colorbar(self):
"""
The 'colorbar' property is an instance of ColorBar
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.ColorBar`
- A dict of string/value properties that will be passed
to the ColorBar constructor
... | [
"def",
"colorbar",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"colorbar\"",
"]"
] | [
208,
4
] | [
434,
31
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.colorscale | (self) |
Sets the colorscale. The colorscale must be an array containing
arrays mapping a normalized value to an rgb, rgba, hex, hsl,
hsv, or named color string. At minimum, a mapping for the
lowest (0) and highest (1) values are required. For example,
`[[0, 'rgb(0,0,255)'], [1, 'rgb(255... |
Sets the colorscale. The colorscale must be an array containing
arrays mapping a normalized value to an rgb, rgba, hex, hsl,
hsv, or named color string. At minimum, a mapping for the
lowest (0) and highest (1) values are required. For example,
`[[0, 'rgb(0,0,255)'], [1, 'rgb(255... | def colorscale(self):
"""
Sets the colorscale. The colorscale must be an array containing
arrays mapping a normalized value to an rgb, rgba, hex, hsl,
hsv, or named color string. At minimum, a mapping for the
lowest (0) and highest (1) values are required. For example,
`[... | [
"def",
"colorscale",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"colorscale\"",
"]"
] | [
443,
4
] | [
486,
33
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.customdata | (self) |
Assigns extra data each datum. This may be useful when
listening to hover, click and selection events. Note that,
"scatter" traces also appends customdata items in the markers
DOM elements
The 'customdata' property is an array that may be specified as a tuple,
list,... |
Assigns extra data each datum. This may be useful when
listening to hover, click and selection events. Note that,
"scatter" traces also appends customdata items in the markers
DOM elements
The 'customdata' property is an array that may be specified as a tuple,
list,... | def customdata(self):
"""
Assigns extra data each datum. This may be useful when
listening to hover, click and selection events. Note that,
"scatter" traces also appends customdata items in the markers
DOM elements
The 'customdata' property is an array that may be sp... | [
"def",
"customdata",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"customdata\"",
"]"
] | [
495,
4
] | [
509,
33
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.customdatasrc | (self) |
Sets the source reference on Chart Studio Cloud for customdata
.
The 'customdatasrc' 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 customdata
.
The 'customdatasrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def customdatasrc(self):
"""
Sets the source reference on Chart Studio Cloud for customdata
.
The 'customdatasrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["cust... | [
"def",
"customdatasrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"customdatasrc\"",
"]"
] | [
518,
4
] | [
530,
36
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.hoverinfo | (self) |
Determines which trace information appear on hover. If `none`
or `skip` are set, no information is displayed upon hovering.
But, if `none` is set, click and hover events are still fired.
The 'hoverinfo' property is a flaglist and may be specified
as a string containing:
... |
Determines which trace information appear on hover. If `none`
or `skip` are set, no information is displayed upon hovering.
But, if `none` is set, click and hover events are still fired.
The 'hoverinfo' property is a flaglist and may be specified
as a string containing:
... | def hoverinfo(self):
"""
Determines which trace information appear on hover. If `none`
or `skip` are set, no information is displayed upon hovering.
But, if `none` is set, click and hover events are still fired.
The 'hoverinfo' property is a flaglist and may be specified
... | [
"def",
"hoverinfo",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"hoverinfo\"",
"]"
] | [
539,
4
] | [
556,
32
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.hoverinfosrc | (self) |
Sets the source reference on Chart Studio Cloud for hoverinfo
.
The 'hoverinfosrc' 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 hoverinfo
.
The 'hoverinfosrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def hoverinfosrc(self):
"""
Sets the source reference on Chart Studio Cloud for hoverinfo
.
The 'hoverinfosrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["hoverin... | [
"def",
"hoverinfosrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"hoverinfosrc\"",
"]"
] | [
565,
4
] | [
577,
35
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.hoverlabel | (self) |
The 'hoverlabel' property is an instance of Hoverlabel
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Hoverlabel`
- A dict of string/value properties that will be passed
to the Hoverlabel constructor
Supported dict proper... |
The 'hoverlabel' property is an instance of Hoverlabel
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Hoverlabel`
- A dict of string/value properties that will be passed
to the Hoverlabel constructor
Supported dict proper... | def hoverlabel(self):
"""
The 'hoverlabel' property is an instance of Hoverlabel
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Hoverlabel`
- A dict of string/value properties that will be passed
to the Hoverlabel constructor
... | [
"def",
"hoverlabel",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"hoverlabel\"",
"]"
] | [
586,
4
] | [
636,
33
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.hovertemplate | (self) |
Template string used for rendering the information that appear
on hover box. Note that this will override `hoverinfo`.
Variables are inserted using %{variable}, for example "y:
%{y}". Numbers are formatted using d3-format's syntax
%{variable:d3-format}, for example "Price: %{y:$... |
Template string used for rendering the information that appear
on hover box. Note that this will override `hoverinfo`.
Variables are inserted using %{variable}, for example "y:
%{y}". Numbers are formatted using d3-format's syntax
%{variable:d3-format}, for example "Price: %{y:$... | def hovertemplate(self):
"""
Template string used for rendering the information that appear
on hover box. Note that this will override `hoverinfo`.
Variables are inserted using %{variable}, for example "y:
%{y}". Numbers are formatted using d3-format's syntax
%{variable:d... | [
"def",
"hovertemplate",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"hovertemplate\"",
"]"
] | [
645,
4
] | [
678,
36
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.hovertemplatesrc | (self) |
Sets the source reference on Chart Studio Cloud for
hovertemplate .
The 'hovertemplatesrc' 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
hovertemplate .
The 'hovertemplatesrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def hovertemplatesrc(self):
"""
Sets the source reference on Chart Studio Cloud for
hovertemplate .
The 'hovertemplatesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return se... | [
"def",
"hovertemplatesrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"hovertemplatesrc\"",
"]"
] | [
687,
4
] | [
699,
39
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.hovertext | (self) |
Same as `text`.
The 'hovertext' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Returns
-------
str
|
Same as `text`.
The 'hovertext' property is a string and must be specified as:
- A string
- A number that will be converted to a string | def hovertext(self):
"""
Same as `text`.
The 'hovertext' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Returns
-------
str
"""
return self["hovertext"] | [
"def",
"hovertext",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"hovertext\"",
"]"
] | [
708,
4
] | [
720,
32
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.ids | (self) |
Assigns id labels to each datum. These ids for object constancy
of data points during animation. Should be an array of strings,
not numbers or any other type.
The 'ids' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Retur... |
Assigns id labels to each datum. These ids for object constancy
of data points during animation. Should be an array of strings,
not numbers or any other type.
The 'ids' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series | def ids(self):
"""
Assigns id labels to each datum. These ids for object constancy
of data points during animation. Should be an array of strings,
not numbers or any other type.
The 'ids' property is an array that may be specified as a tuple,
list, numpy array, or pa... | [
"def",
"ids",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"ids\"",
"]"
] | [
729,
4
] | [
742,
26
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.idssrc | (self) |
Sets the source reference on Chart Studio Cloud for ids .
The 'idssrc' 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 ids .
The 'idssrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def idssrc(self):
"""
Sets the source reference on Chart Studio Cloud for ids .
The 'idssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["idssrc"] | [
"def",
"idssrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"idssrc\"",
"]"
] | [
751,
4
] | [
762,
29
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.legendgroup | (self) |
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
R... |
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string | def legendgroup(self):
"""
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will b... | [
"def",
"legendgroup",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"legendgroup\"",
"]"
] | [
771,
4
] | [
785,
34
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.lighting | (self) |
The 'lighting' property is an instance of Lighting
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Lighting`
- A dict of string/value properties that will be passed
to the Lighting constructor
Supported dict properties:
... |
The 'lighting' property is an instance of Lighting
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Lighting`
- A dict of string/value properties that will be passed
to the Lighting constructor
Supported dict properties:
... | def lighting(self):
"""
The 'lighting' property is an instance of Lighting
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Lighting`
- A dict of string/value properties that will be passed
to the Lighting constructor
... | [
"def",
"lighting",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"lighting\"",
"]"
] | [
794,
4
] | [
833,
31
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.lightposition | (self) |
The 'lightposition' property is an instance of Lightposition
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Lightposition`
- A dict of string/value properties that will be passed
to the Lightposition constructor
Supported... |
The 'lightposition' property is an instance of Lightposition
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Lightposition`
- A dict of string/value properties that will be passed
to the Lightposition constructor
Supported... | def lightposition(self):
"""
The 'lightposition' property is an instance of Lightposition
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Lightposition`
- A dict of string/value properties that will be passed
to the Lightposition co... | [
"def",
"lightposition",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"lightposition\"",
"]"
] | [
842,
4
] | [
866,
36
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.maxdisplayed | (self) |
The maximum number of displayed segments in a streamtube.
The 'maxdisplayed' property is a integer and may be specified as:
- An int (or float that will be cast to an int)
in the interval [0, 9223372036854775807]
Returns
-------
int
|
The maximum number of displayed segments in a streamtube.
The 'maxdisplayed' property is a integer and may be specified as:
- An int (or float that will be cast to an int)
in the interval [0, 9223372036854775807] | def maxdisplayed(self):
"""
The maximum number of displayed segments in a streamtube.
The 'maxdisplayed' property is a integer and may be specified as:
- An int (or float that will be cast to an int)
in the interval [0, 9223372036854775807]
Returns
---... | [
"def",
"maxdisplayed",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"maxdisplayed\"",
"]"
] | [
875,
4
] | [
887,
35
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.meta | (self) |
Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace `name`, graph, axis and colorbar `title.text`, annotation
`text` `rangeselector`, `updatemenues` and `sliders` `label`
text all support `meta`. To acce... |
Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace `name`, graph, axis and colorbar `title.text`, annotation
`text` `rangeselector`, `updatemenues` and `sliders` `label`
text all support `meta`. To acce... | def meta(self):
"""
Assigns extra meta information associated with this trace that
can be used in various text attributes. Attributes such as
trace `name`, graph, axis and colorbar `title.text`, annotation
`text` `rangeselector`, `updatemenues` and `sliders` `label`
text ... | [
"def",
"meta",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"meta\"",
"]"
] | [
896,
4
] | [
915,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.metasrc | (self) |
Sets the source reference on Chart Studio Cloud for meta .
The 'metasrc' 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 meta .
The 'metasrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def metasrc(self):
"""
Sets the source reference on Chart Studio Cloud for meta .
The 'metasrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["metasrc"] | [
"def",
"metasrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"metasrc\"",
"]"
] | [
924,
4
] | [
935,
30
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.name | (self) |
Sets the trace name. The trace name appear as the legend item
and on hover.
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Returns
-------
str
|
Sets the trace name. The trace name appear as the legend item
and on hover.
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string | def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Returns
-------
str
... | [
"def",
"name",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"name\"",
"]"
] | [
944,
4
] | [
957,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.opacity | (self) |
Sets the opacity of the surface. Please note that in the case
of using high `opacity` values for example a value greater than
or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
an overlay of multiple transparent surfaces may not perfectly
be sorted in depth by the we... |
Sets the opacity of the surface. Please note that in the case
of using high `opacity` values for example a value greater than
or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
an overlay of multiple transparent surfaces may not perfectly
be sorted in depth by the we... | def opacity(self):
"""
Sets the opacity of the surface. Please note that in the case
of using high `opacity` values for example a value greater than
or equal to 0.5 on two surfaces (and 0.25 with four surfaces),
an overlay of multiple transparent surfaces may not perfectly
... | [
"def",
"opacity",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"opacity\"",
"]"
] | [
966,
4
] | [
982,
30
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.reversescale | (self) |
Reverses the color mapping if true. If true, `cmin` will
correspond to the last color in the array and `cmax` will
correspond to the first color.
The 'reversescale' property must be specified as a bool
(either True, or False)
Returns
-------
bool
... |
Reverses the color mapping if true. If true, `cmin` will
correspond to the last color in the array and `cmax` will
correspond to the first color.
The 'reversescale' property must be specified as a bool
(either True, or False) | def reversescale(self):
"""
Reverses the color mapping if true. If true, `cmin` will
correspond to the last color in the array and `cmax` will
correspond to the first color.
The 'reversescale' property must be specified as a bool
(either True, or False)
Retu... | [
"def",
"reversescale",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"reversescale\"",
"]"
] | [
991,
4
] | [
1004,
35
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.scene | (self) |
Sets a reference between this trace's 3D coordinate system and
a 3D scene. If "scene" (the default value), the (x,y,z)
coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
coordinates refer to `layout.scene2`, and so on.
The 'scene' property is an identifier of a p... |
Sets a reference between this trace's 3D coordinate system and
a 3D scene. If "scene" (the default value), the (x,y,z)
coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
coordinates refer to `layout.scene2`, and so on.
The 'scene' property is an identifier of a p... | def scene(self):
"""
Sets a reference between this trace's 3D coordinate system and
a 3D scene. If "scene" (the default value), the (x,y,z)
coordinates refer to `layout.scene`. If "scene2", the (x,y,z)
coordinates refer to `layout.scene2`, and so on.
The 'scene' prop... | [
"def",
"scene",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"scene\"",
"]"
] | [
1013,
4
] | [
1029,
28
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.showlegend | (self) |
Determines whether or not an item corresponding to this trace
is shown in the legend.
The 'showlegend' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Determines whether or not an item corresponding to this trace
is shown in the legend.
The 'showlegend' property must be specified as a bool
(either True, or False) | def showlegend(self):
"""
Determines whether or not an item corresponding to this trace
is shown in the legend.
The 'showlegend' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
return self["showle... | [
"def",
"showlegend",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showlegend\"",
"]"
] | [
1038,
4
] | [
1050,
33
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.showscale | (self) |
Determines whether or not a colorbar is displayed for this
trace.
The 'showscale' property must be specified as a bool
(either True, or False)
Returns
-------
bool
|
Determines whether or not a colorbar is displayed for this
trace.
The 'showscale' property must be specified as a bool
(either True, or False) | def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
The 'showscale' property must be specified as a bool
(either True, or False)
Returns
-------
bool
"""
return self["showscale"] | [
"def",
"showscale",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"showscale\"",
"]"
] | [
1059,
4
] | [
1071,
32
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.sizeref | (self) |
The scaling factor for the streamtubes. The default is 1, which
avoids two max divergence tubes from touching at adjacent
starting positions.
The 'sizeref' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
--... |
The scaling factor for the streamtubes. The default is 1, which
avoids two max divergence tubes from touching at adjacent
starting positions.
The 'sizeref' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def sizeref(self):
"""
The scaling factor for the streamtubes. The default is 1, which
avoids two max divergence tubes from touching at adjacent
starting positions.
The 'sizeref' property is a number and may be specified as:
- An int or float in the interval [0, in... | [
"def",
"sizeref",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"sizeref\"",
"]"
] | [
1080,
4
] | [
1093,
30
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.starts | (self) |
The 'starts' property is an instance of Starts
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Starts`
- A dict of string/value properties that will be passed
to the Starts constructor
Supported dict properties:
... |
The 'starts' property is an instance of Starts
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Starts`
- A dict of string/value properties that will be passed
to the Starts constructor
Supported dict properties:
... | def starts(self):
"""
The 'starts' property is an instance of Starts
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Starts`
- A dict of string/value properties that will be passed
to the Starts constructor
Supporte... | [
"def",
"starts",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"starts\"",
"]"
] | [
1102,
4
] | [
1135,
29
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.stream | (self) |
The 'stream' property is an instance of Stream
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Stream`
- A dict of string/value properties that will be passed
to the Stream constructor
Supported dict properties:
... |
The 'stream' property is an instance of Stream
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Stream`
- A dict of string/value properties that will be passed
to the Stream constructor
Supported dict properties:
... | def stream(self):
"""
The 'stream' property is an instance of Stream
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.Stream`
- A dict of string/value properties that will be passed
to the Stream constructor
Supporte... | [
"def",
"stream",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"stream\"",
"]"
] | [
1144,
4
] | [
1168,
29
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.text | (self) |
Sets a text element associated with this trace. If trace
`hoverinfo` contains a "text" flag, this text element will be
seen in all hover labels. Note that streamtube traces do not
support array `text` values.
The 'text' property is a string and must be specified as:
... |
Sets a text element associated with this trace. If trace
`hoverinfo` contains a "text" flag, this text element will be
seen in all hover labels. Note that streamtube traces do not
support array `text` values.
The 'text' property is a string and must be specified as:
... | def text(self):
"""
Sets a text element associated with this trace. If trace
`hoverinfo` contains a "text" flag, this text element will be
seen in all hover labels. Note that streamtube traces do not
support array `text` values.
The 'text' property is a string and mu... | [
"def",
"text",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"text\"",
"]"
] | [
1177,
4
] | [
1192,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.u | (self) |
Sets the x components of the vector field.
The 'u' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
|
Sets the x components of the vector field.
The 'u' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series | def u(self):
"""
Sets the x components of the vector field.
The 'u' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
"""
return self["u"] | [
"def",
"u",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"u\"",
"]"
] | [
1201,
4
] | [
1212,
24
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.uid | (self) |
Assign an id to this trace, Use this to provide object
constancy between traces during animations and transitions.
The 'uid' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Returns
-------
... |
Assign an id to this trace, Use this to provide object
constancy between traces during animations and transitions.
The 'uid' property is a string and must be specified as:
- A string
- A number that will be converted to a string | def uid(self):
"""
Assign an id to this trace, Use this to provide object
constancy between traces during animations and transitions.
The 'uid' property is a string and must be specified as:
- A string
- A number that will be converted to a string
Return... | [
"def",
"uid",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"uid\"",
"]"
] | [
1221,
4
] | [
1234,
26
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.uirevision | (self) |
Controls persistence of some user-driven changes to the trace:
`constraintrange` in `parcoords` traces, as well as some
`editable: true` modifications such as `name` and
`colorbar.title`. Defaults to `layout.uirevision`. Note that
other user-driven trace attribute changes are co... |
Controls persistence of some user-driven changes to the trace:
`constraintrange` in `parcoords` traces, as well as some
`editable: true` modifications such as `name` and
`colorbar.title`. Defaults to `layout.uirevision`. Note that
other user-driven trace attribute changes are co... | def uirevision(self):
"""
Controls persistence of some user-driven changes to the trace:
`constraintrange` in `parcoords` traces, as well as some
`editable: true` modifications such as `name` and
`colorbar.title`. Defaults to `layout.uirevision`. Note that
other user-driv... | [
"def",
"uirevision",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"uirevision\"",
"]"
] | [
1243,
4
] | [
1267,
33
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.usrc | (self) |
Sets the source reference on Chart Studio Cloud for u .
The 'usrc' 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 u .
The 'usrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def usrc(self):
"""
Sets the source reference on Chart Studio Cloud for u .
The 'usrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["usrc"] | [
"def",
"usrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"usrc\"",
"]"
] | [
1276,
4
] | [
1287,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.v | (self) |
Sets the y components of the vector field.
The 'v' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
|
Sets the y components of the vector field.
The 'v' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series | def v(self):
"""
Sets the y components of the vector field.
The 'v' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
"""
return self["v"] | [
"def",
"v",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"v\"",
"]"
] | [
1296,
4
] | [
1307,
24
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.visible | (self) |
Determines whether or not this trace is visible. If
"legendonly", the trace is not drawn, but can appear as a
legend item (provided that the legend itself is visible).
The 'visible' property is an enumeration that may be specified as:
- One of the following enumeration va... |
Determines whether or not this trace is visible. If
"legendonly", the trace is not drawn, but can appear as a
legend item (provided that the legend itself is visible).
The 'visible' property is an enumeration that may be specified as:
- One of the following enumeration va... | def visible(self):
"""
Determines whether or not this trace is visible. If
"legendonly", the trace is not drawn, but can appear as a
legend item (provided that the legend itself is visible).
The 'visible' property is an enumeration that may be specified as:
- One o... | [
"def",
"visible",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"visible\"",
"]"
] | [
1316,
4
] | [
1330,
30
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.vsrc | (self) |
Sets the source reference on Chart Studio Cloud for v .
The 'vsrc' 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 v .
The 'vsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def vsrc(self):
"""
Sets the source reference on Chart Studio Cloud for v .
The 'vsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["vsrc"] | [
"def",
"vsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"vsrc\"",
"]"
] | [
1339,
4
] | [
1350,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.w | (self) |
Sets the z components of the vector field.
The 'w' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
|
Sets the z components of the vector field.
The 'w' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series | def w(self):
"""
Sets the z components of the vector field.
The 'w' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
"""
return self["w"] | [
"def",
"w",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"w\"",
"]"
] | [
1359,
4
] | [
1370,
24
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.wsrc | (self) |
Sets the source reference on Chart Studio Cloud for w .
The 'wsrc' 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 w .
The 'wsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def wsrc(self):
"""
Sets the source reference on Chart Studio Cloud for w .
The 'wsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["wsrc"] | [
"def",
"wsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"wsrc\"",
"]"
] | [
1379,
4
] | [
1390,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.x | (self) |
Sets the x coordinates of the vector field.
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
|
Sets the x coordinates of the vector field.
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series | def x(self):
"""
Sets the x coordinates of the vector field.
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
"""
return self["x"] | [
"def",
"x",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"x\"",
"]"
] | [
1399,
4
] | [
1410,
24
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.xsrc | (self) |
Sets the source reference on Chart Studio Cloud for x .
The 'xsrc' 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 x .
The 'xsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def xsrc(self):
"""
Sets the source reference on Chart Studio Cloud for x .
The 'xsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["xsrc"] | [
"def",
"xsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"xsrc\"",
"]"
] | [
1419,
4
] | [
1430,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.y | (self) |
Sets the y coordinates of the vector field.
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
|
Sets the y coordinates of the vector field.
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series | def y(self):
"""
Sets the y coordinates of the vector field.
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
"""
return self["y"] | [
"def",
"y",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"y\"",
"]"
] | [
1439,
4
] | [
1450,
24
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.ysrc | (self) |
Sets the source reference on Chart Studio Cloud for y .
The 'ysrc' 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 y .
The 'ysrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def ysrc(self):
"""
Sets the source reference on Chart Studio Cloud for y .
The 'ysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["ysrc"] | [
"def",
"ysrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"ysrc\"",
"]"
] | [
1459,
4
] | [
1470,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.z | (self) |
Sets the z coordinates of the vector field.
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
|
Sets the z coordinates of the vector field.
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series | def z(self):
"""
Sets the z coordinates of the vector field.
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
Returns
-------
numpy.ndarray
"""
return self["z"] | [
"def",
"z",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"z\"",
"]"
] | [
1479,
4
] | [
1490,
24
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.zsrc | (self) |
Sets the source reference on Chart Studio Cloud for z .
The 'zsrc' 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 z .
The 'zsrc' property must be specified as a string or
as a plotly.grid_objs.Column object | def zsrc(self):
"""
Sets the source reference on Chart Studio Cloud for z .
The 'zsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
Returns
-------
str
"""
return self["zsrc"] | [
"def",
"zsrc",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"zsrc\"",
"]"
] | [
1499,
4
] | [
1510,
27
] | python | en | ['en', 'error', 'th'] | False |
Streamtube.__init__ | (
self,
arg=None,
autocolorscale=None,
cauto=None,
cmax=None,
cmid=None,
cmin=None,
coloraxis=None,
colorbar=None,
colorscale=None,
customdata=None,
customdatasrc=None,
hoverinfo=None,
hoverinfosrc=None,
... |
Construct a new Streamtube object
Use a streamtube trace to visualize flow in a vector field.
Specify a vector field using 6 1D arrays of equal length, 3
position arrays `x`, `y` and `z` and 3 vector component arrays
`u`, `v`, and `w`. By default, the tubes' starting p... |
Construct a new Streamtube object
Use a streamtube trace to visualize flow in a vector field.
Specify a vector field using 6 1D arrays of equal length, 3
position arrays `x`, `y` and `z` and 3 vector component arrays
`u`, `v`, and `w`. By default, the tubes' starting p... | def __init__(
self,
arg=None,
autocolorscale=None,
cauto=None,
cmax=None,
cmid=None,
cmin=None,
coloraxis=None,
colorbar=None,
colorscale=None,
customdata=None,
customdatasrc=None,
hoverinfo=None,
hoverinfosr... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"autocolorscale",
"=",
"None",
",",
"cauto",
"=",
"None",
",",
"cmax",
"=",
"None",
",",
"cmid",
"=",
"None",
",",
"cmin",
"=",
"None",
",",
"coloraxis",
"=",
"None",
",",
"colorbar",
"=... | [
1760,
4
] | [
2306,
34
] | python | en | ['en', 'error', 'th'] | False |
TestDictionary.test_space_tokenize | (self) |
Space tokenize assumes raw tokenization as input.
|
Space tokenize assumes raw tokenization as input.
| def test_space_tokenize(self):
"""
Space tokenize assumes raw tokenization as input.
"""
self.assertEqual(
DictionaryAgent.space_tokenize(' this is a test! '),
['this', 'is', 'a', 'test!'],
) | [
"def",
"test_space_tokenize",
"(",
"self",
")",
":",
"self",
".",
"assertEqual",
"(",
"DictionaryAgent",
".",
"space_tokenize",
"(",
"' this is a test! '",
")",
",",
"[",
"'this'",
",",
"'is'",
",",
"'a'",
",",
"'test!'",
"]",
",",
")"
] | [
103,
4
] | [
110,
9
] | python | en | ['en', 'error', 'th'] | False |
TestDictionary.test_split_tokenize | (self) |
Split tokenize specially handles some limited punctuation.
|
Split tokenize specially handles some limited punctuation.
| def test_split_tokenize(self):
"""
Split tokenize specially handles some limited punctuation.
"""
self.assertEqual(
DictionaryAgent.split_tokenize(' this is a test! '),
['this', 'is', 'a', 'test', '!'],
) | [
"def",
"test_split_tokenize",
"(",
"self",
")",
":",
"self",
".",
"assertEqual",
"(",
"DictionaryAgent",
".",
"split_tokenize",
"(",
"' this is a test! '",
")",
",",
"[",
"'this'",
",",
"'is'",
",",
"'a'",
",",
"'test'",
",",
"'!'",
"]",
",",
")"
] | [
112,
4
] | [
119,
9
] | python | en | ['en', 'error', 'th'] | False |
TestDictionary.test_find_ngrams | (self) |
Test the ngram class properly recognize uni, bi, and trigrams test.
|
Test the ngram class properly recognize uni, bi, and trigrams test.
| def test_find_ngrams(self):
"""
Test the ngram class properly recognize uni, bi, and trigrams test.
"""
s = set()
s.add('hello world')
s.add('ol boy')
res = find_ngrams(s, ['hello', 'world', 'buddy', 'ol', 'boy'], 2)
assert ' '.join(res) == 'hello world bu... | [
"def",
"test_find_ngrams",
"(",
"self",
")",
":",
"s",
"=",
"set",
"(",
")",
"s",
".",
"add",
"(",
"'hello world'",
")",
"s",
".",
"add",
"(",
"'ol boy'",
")",
"res",
"=",
"find_ngrams",
"(",
"s",
",",
"[",
"'hello'",
",",
"'world'",
",",
"'buddy'"... | [
121,
4
] | [
138,
58
] | python | en | ['en', 'error', 'th'] | False |
TestDictionary.test_basic_parse | (self) |
Check the dictionary is correctly adding and parsing short sentence.
|
Check the dictionary is correctly adding and parsing short sentence.
| def test_basic_parse(self):
"""
Check the dictionary is correctly adding and parsing short sentence.
"""
parser = ParlaiParser()
DictionaryAgent.add_cmdline_args(parser, partial_opt=None)
opt = parser.parse_args([])
dictionary = DictionaryAgent(opt)
num_bu... | [
"def",
"test_basic_parse",
"(",
"self",
")",
":",
"parser",
"=",
"ParlaiParser",
"(",
")",
"DictionaryAgent",
".",
"add_cmdline_args",
"(",
"parser",
",",
"partial_opt",
"=",
"None",
")",
"opt",
"=",
"parser",
".",
"parse_args",
"(",
"[",
"]",
")",
"dictio... | [
140,
4
] | [
167,
40
] | python | en | ['en', 'error', 'th'] | False |
TestDictionary.test_set_model_file_without_dict_file | (self) |
Check that moving a model without moving the dictfile raises an error.
|
Check that moving a model without moving the dictfile raises an error.
| def test_set_model_file_without_dict_file(self):
"""
Check that moving a model without moving the dictfile raises an error.
"""
# Download model, move to a new location
with testing_utils.tempdir() as datapath:
try:
# remove unittest models if there be... | [
"def",
"test_set_model_file_without_dict_file",
"(",
"self",
")",
":",
"# Download model, move to a new location",
"with",
"testing_utils",
".",
"tempdir",
"(",
")",
"as",
"datapath",
":",
"try",
":",
"# remove unittest models if there before",
"shutil",
".",
"rmtree",
"(... | [
170,
4
] | [
194,
20
] | python | en | ['en', 'error', 'th'] | False |
TestDictionary.test_train_model_with_no_dict_file | (self) |
Ensure training a model requires a dict_file or model_file.
|
Ensure training a model requires a dict_file or model_file.
| def test_train_model_with_no_dict_file(self):
"""
Ensure training a model requires a dict_file or model_file.
"""
import parlai.scripts.train_model as tms
parser = tms.setup_args()
parser.set_params(task='babi:task1k:1', model='seq2seq')
popt = parser.parse_args(... | [
"def",
"test_train_model_with_no_dict_file",
"(",
"self",
")",
":",
"import",
"parlai",
".",
"scripts",
".",
"train_model",
"as",
"tms",
"parser",
"=",
"tms",
".",
"setup_args",
"(",
")",
"parser",
".",
"set_params",
"(",
"task",
"=",
"'babi:task1k:1'",
",",
... | [
196,
4
] | [
206,
31
] | python | en | ['en', 'error', 'th'] | False |
TestGpt2HFInterop._run_test | (self, slow_bytelevel_bpe, hf_bpe) |
run the actual test.
|
run the actual test.
| def _run_test(self, slow_bytelevel_bpe, hf_bpe):
"""
run the actual test.
"""
self.assertEqual(
# grinning face emoji
slow_bytelevel_bpe.bytelevelbpe_tokenize(u'Hello, ParlAI! \U0001f600'),
slow_bytelevel_bpe_RESULT,
)
self.assertEqual(... | [
"def",
"_run_test",
"(",
"self",
",",
"slow_bytelevel_bpe",
",",
"hf_bpe",
")",
":",
"self",
".",
"assertEqual",
"(",
"# grinning face emoji",
"slow_bytelevel_bpe",
".",
"bytelevelbpe_tokenize",
"(",
"u'Hello, ParlAI! \\U0001f600'",
")",
",",
"slow_bytelevel_bpe_RESULT",
... | [
462,
4
] | [
496,
9
] | python | en | ['en', 'error', 'th'] | False |
TestGpt2HFInterop._run_prefix_space_test | (self, agent) |
Tests gpt2standin can handle prefix space.
|
Tests gpt2standin can handle prefix space.
| def _run_prefix_space_test(self, agent):
"""
Tests gpt2standin can handle prefix space.
"""
self.assertEqual(
# grinning face emoji
agent.bytelevelbpe_tokenize(u'Hello, ParlAI! \U0001f600'),
['\\xc4\\xa0'] + slow_bytelevel_bpe_RESULT,
)
... | [
"def",
"_run_prefix_space_test",
"(",
"self",
",",
"agent",
")",
":",
"self",
".",
"assertEqual",
"(",
"# grinning face emoji",
"agent",
".",
"bytelevelbpe_tokenize",
"(",
"u'Hello, ParlAI! \\U0001f600'",
")",
",",
"[",
"'\\\\xc4\\\\xa0'",
"]",
"+",
"slow_bytelevel_bp... | [
525,
4
] | [
544,
9
] | python | en | ['en', 'error', 'th'] | False |
export | (mesh_file,
agg_file,
seg_file,
meta_file,
label_map_file,
output_file=None) | Export original files to vert, ins_label, sem_label and bbox file.
Args:
mesh_file (str): Path of the mesh_file.
agg_file (str): Path of the agg_file.
seg_file (str): Path of the seg_file.
meta_file (str): Path of the meta_file.
label_map_file (str): Path of the label_map_fi... | Export original files to vert, ins_label, sem_label and bbox file. | def export(mesh_file,
agg_file,
seg_file,
meta_file,
label_map_file,
output_file=None):
"""Export original files to vert, ins_label, sem_label and bbox file.
Args:
mesh_file (str): Path of the mesh_file.
agg_file (str): Path of the agg_file... | [
"def",
"export",
"(",
"mesh_file",
",",
"agg_file",
",",
"seg_file",
",",
"meta_file",
",",
"label_map_file",
",",
"output_file",
"=",
"None",
")",
":",
"label_map",
"=",
"scannet_utils",
".",
"read_label_mapping",
"(",
"label_map_file",
",",
"label_from",
"=",
... | [
54,
0
] | [
142,
46
] | python | en | ['en', 'da', 'en'] | True |
Stream.maxpoints | (self) |
Sets the maximum number of points to keep on the plots from an
incoming stream. If `maxpoints` is set to 50, only the newest
50 points will be displayed on the plot.
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]... |
Sets the maximum number of points to keep on the plots from an
incoming stream. If `maxpoints` is set to 50, only the newest
50 points will be displayed on the plot.
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000] | def maxpoints(self):
"""
Sets the maximum number of points to keep on the plots from an
incoming stream. If `maxpoints` is set to 50, only the newest
50 points will be displayed on the plot.
The 'maxpoints' property is a number and may be specified as:
- An int or ... | [
"def",
"maxpoints",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"maxpoints\"",
"]"
] | [
15,
4
] | [
28,
32
] | python | en | ['en', 'error', 'th'] | False |
Stream.token | (self) |
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
The 'token' property is a string and must be specified as:
- A non-empty string
Returns
-------
str
|
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
The 'token' property is a string and must be specified as:
- A non-empty string | def token(self):
"""
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
The 'token' property is a string and must be specified as:
- A non-empty string
Returns
-------
... | [
"def",
"token",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"token\"",
"]"
] | [
37,
4
] | [
50,
28
] | python | en | ['en', 'error', 'th'] | False |
Stream.__init__ | (self, arg=None, maxpoints=None, token=None, **kwargs) |
Construct a new Stream object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.scatterpolargl.Stream`
maxpoints
Sets the maximum number of points to ... |
Construct a new Stream object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.scatterpolargl.Stream`
maxpoints
Sets the maximum number of points to ... | def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.scatterpola... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"maxpoints",
"=",
"None",
",",
"token",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"super",
"(",
"Stream",
",",
"self",
")",
".",
"__init__",
"(",
"\"stream\"",
")",
"if",
"\"_paren... | [
72,
4
] | [
140,
34
] | python | en | ['en', 'error', 'th'] | False |
Font.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
] | [
63,
28
] | python | en | ['en', 'error', 'th'] | False |
Font.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\"",
"]"
] | [
72,
4
] | [
94,
29
] | python | en | ['en', 'error', 'th'] | False |
Font.size | (self) |
The 'size' property is a number and may be specified as:
- An int or float in the interval [1, inf]
Returns
-------
int|float
|
The 'size' property is a number and may be specified as:
- An int or float in the interval [1, inf] | def size(self):
"""
The 'size' property is a number and may be specified as:
- An int or float in the interval [1, inf]
Returns
-------
int|float
"""
return self["size"] | [
"def",
"size",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"size\"",
"]"
] | [
103,
4
] | [
112,
27
] | python | en | ['en', 'error', 'th'] | False |
Font.__init__ | (self, arg=None, color=None, family=None, size=None, **kwargs) |
Construct a new Font object
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
Parameters
----------
arg
dict of properties compatible with this constructor or
an inst... |
Construct a new Font object
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute. | def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
Parameters
----------
arg... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"color",
"=",
"None",
",",
"family",
"=",
"None",
",",
"size",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"super",
"(",
"Font",
",",
"self",
")",
".",
"__init__",
"(",
"\"font\"",... | [
143,
4
] | [
227,
34
] | python | en | ['en', 'error', 'th'] | False |
Tiling.flip | (self) |
Determines if the positions obtained from solver are flipped on
each axis.
The 'flip' property is a flaglist and may be specified
as a string containing:
- Any combination of ['x', 'y'] joined with '+' characters
(e.g. 'x+y')
Returns
-------
... |
Determines if the positions obtained from solver are flipped on
each axis.
The 'flip' property is a flaglist and may be specified
as a string containing:
- Any combination of ['x', 'y'] joined with '+' characters
(e.g. 'x+y') | def flip(self):
"""
Determines if the positions obtained from solver are flipped on
each axis.
The 'flip' property is a flaglist and may be specified
as a string containing:
- Any combination of ['x', 'y'] joined with '+' characters
(e.g. 'x+y')
... | [
"def",
"flip",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"flip\"",
"]"
] | [
15,
4
] | [
29,
27
] | python | en | ['en', 'error', 'th'] | False |
Tiling.packing | (self) |
Determines d3 treemap solver. For more info please refer to
https://github.com/d3/d3-hierarchy#treemap-tiling
The 'packing' property is an enumeration that may be specified as:
- One of the following enumeration values:
['squarify', 'binary', 'dice', 'slice', 'sli... |
Determines d3 treemap solver. For more info please refer to
https://github.com/d3/d3-hierarchy#treemap-tiling
The 'packing' property is an enumeration that may be specified as:
- One of the following enumeration values:
['squarify', 'binary', 'dice', 'slice', 'sli... | def packing(self):
"""
Determines d3 treemap solver. For more info please refer to
https://github.com/d3/d3-hierarchy#treemap-tiling
The 'packing' property is an enumeration that may be specified as:
- One of the following enumeration values:
['squarify', '... | [
"def",
"packing",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"packing\"",
"]"
] | [
38,
4
] | [
52,
30
] | python | en | ['en', 'error', 'th'] | False |
Tiling.pad | (self) |
Sets the inner padding (in px).
The 'pad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
|
Sets the inner padding (in px).
The 'pad' property is a number and may be specified as:
- An int or float in the interval [0, inf] | def pad(self):
"""
Sets the inner padding (in px).
The 'pad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
Returns
-------
int|float
"""
return self["pad"] | [
"def",
"pad",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"pad\"",
"]"
] | [
61,
4
] | [
72,
26
] | python | en | ['en', 'error', 'th'] | False |
Tiling.squarifyratio | (self) |
When using "squarify" `packing` algorithm, according to https:/
/github.com/d3/d3-hierarchy/blob/master/README.md#squarify_rati
o this option specifies the desired aspect ratio of the
generated rectangles. The ratio must be specified as a number
greater than or equal to one. Not... |
When using "squarify" `packing` algorithm, according to https:/
/github.com/d3/d3-hierarchy/blob/master/README.md#squarify_rati
o this option specifies the desired aspect ratio of the
generated rectangles. The ratio must be specified as a number
greater than or equal to one. Not... | def squarifyratio(self):
"""
When using "squarify" `packing` algorithm, according to https:/
/github.com/d3/d3-hierarchy/blob/master/README.md#squarify_rati
o this option specifies the desired aspect ratio of the
generated rectangles. The ratio must be specified as a number
... | [
"def",
"squarifyratio",
"(",
"self",
")",
":",
"return",
"self",
"[",
"\"squarifyratio\"",
"]"
] | [
81,
4
] | [
102,
36
] | python | en | ['en', 'error', 'th'] | False |
Tiling.__init__ | (
self, arg=None, flip=None, packing=None, pad=None, squarifyratio=None, **kwargs
) |
Construct a new Tiling object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.treemap.Tiling`
flip
Determines if the positions obtained from solver ... |
Construct a new Tiling object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
:class:`plotly.graph_objs.treemap.Tiling`
flip
Determines if the positions obtained from solver ... | def __init__(
self, arg=None, flip=None, packing=None, pad=None, squarifyratio=None, **kwargs
):
"""
Construct a new Tiling object
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of
... | [
"def",
"__init__",
"(",
"self",
",",
"arg",
"=",
"None",
",",
"flip",
"=",
"None",
",",
"packing",
"=",
"None",
",",
"pad",
"=",
"None",
",",
"squarifyratio",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"super",
"(",
"Tiling",
",",
"self",
")... | [
137,
4
] | [
228,
34
] | python | en | ['en', 'error', 'th'] | False |
Tournament.start | (self) | start the tournament on Challonge
|methcoro|
Note:
|from_api| Start a tournament, opening up first round matches for score reporting. The tournament must have at least 2 participants.
Raises:
APIException
| start the tournament on Challonge | async def start(self):
""" start the tournament on Challonge
|methcoro|
Note:
|from_api| Start a tournament, opening up first round matches for score reporting. The tournament must have at least 2 participants.
Raises:
APIException
"""
params =... | [
"async",
"def",
"start",
"(",
"self",
")",
":",
"params",
"=",
"{",
"'include_participants'",
":",
"1",
"if",
"AUTO_GET_PARTICIPANTS",
"else",
"0",
",",
"'include_matches'",
":",
"1",
"if",
"AUTO_GET_MATCHES",
"else",
"0",
"}",
"res",
"=",
"await",
"self",
... | [
107,
4
] | [
124,
36
] | python | en | ['en', 'fi', 'en'] | True |
Tournament.reset | (self) | reset the tournament on Challonge
|methcoro|
Note:
|from_api| Reset a tournament, clearing all of its scores and attachments. You can then add/remove/edit participants before starting the tournament again.
Raises:
APIException
| reset the tournament on Challonge | async def reset(self):
""" reset the tournament on Challonge
|methcoro|
Note:
|from_api| Reset a tournament, clearing all of its scores and attachments. You can then add/remove/edit participants before starting the tournament again.
Raises:
APIException
... | [
"async",
"def",
"reset",
"(",
"self",
")",
":",
"params",
"=",
"{",
"'include_participants'",
":",
"1",
"if",
"AUTO_GET_PARTICIPANTS",
"else",
"0",
",",
"'include_matches'",
":",
"1",
"if",
"AUTO_GET_MATCHES",
"else",
"0",
"}",
"res",
"=",
"await",
"self",
... | [
126,
4
] | [
143,
36
] | python | en | ['en', 'sr', 'en'] | True |
Tournament.finalize | (self) | finalize the tournament on Challonge
|methcoro|
Note:
|from_api| Finalize a tournament that has had all match scores submitted, rendering its results permanent.
Raises:
APIException
| finalize the tournament on Challonge | async def finalize(self):
""" finalize the tournament on Challonge
|methcoro|
Note:
|from_api| Finalize a tournament that has had all match scores submitted, rendering its results permanent.
Raises:
APIException
"""
params = {
'... | [
"async",
"def",
"finalize",
"(",
"self",
")",
":",
"params",
"=",
"{",
"'include_participants'",
":",
"1",
"if",
"AUTO_GET_PARTICIPANTS",
"else",
"0",
",",
"'include_matches'",
":",
"1",
"if",
"AUTO_GET_MATCHES",
"else",
"0",
"}",
"res",
"=",
"await",
"self"... | [
145,
4
] | [
162,
36
] | python | en | ['en', 'en', 'en'] | True |
Tournament.update | (self, **params) | update some parameters of the tournament
Use this function if you want to update multiple options at once, but prefer helpers functions like :func:`allow_attachments`, :func:`set_start_date`...
|methcoro|
Args:
params: one or more of: ``name`` ``tournament_type`` ``url`` ``subdom... | update some parameters of the tournament | async def update(self, **params):
""" update some parameters of the tournament
Use this function if you want to update multiple options at once, but prefer helpers functions like :func:`allow_attachments`, :func:`set_start_date`...
|methcoro|
Args:
params: one or more of: ... | [
"async",
"def",
"update",
"(",
"self",
",",
"*",
"*",
"params",
")",
":",
"assert_or_raise",
"(",
"all",
"(",
"k",
"in",
"self",
".",
"_update_parameters",
"for",
"k",
"in",
"params",
".",
"keys",
"(",
")",
")",
",",
"NameError",
",",
"'Wrong parameter... | [
164,
4
] | [
192,
36
] | python | en | ['en', 'en', 'en'] | True |
Tournament.update_tournament_type | (self, tournament_type: TournamentType) |
|methcoro|
Args:
tournament_type: choose between TournamentType.single_elimination, TournamentType.double_elimination, TournamentType.round_robin, TournamentType.swiss
Raises:
APIException
| async def update_tournament_type(self, tournament_type: TournamentType):
"""
|methcoro|
Args:
tournament_type: choose between TournamentType.single_elimination, TournamentType.double_elimination, TournamentType.round_robin, TournamentType.swiss
Raises:
APIExcep... | [
"async",
"def",
"update_tournament_type",
"(",
"self",
",",
"tournament_type",
":",
"TournamentType",
")",
":",
"await",
"self",
".",
"update",
"(",
"tournament_type",
"=",
"tournament_type",
".",
"value",
")"
] | [
194,
4
] | [
206,
64
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.update_name | (self, new_name: str) |
|methcoro|
Args:
new_name: the name to be changed to (Max: 60 characters)
Raises:
APIException
| async def update_name(self, new_name: str):
"""
|methcoro|
Args:
new_name: the name to be changed to (Max: 60 characters)
Raises:
APIException
"""
# TODO: check str 60 chars
await self.update(name=new_name) | [
"async",
"def",
"update_name",
"(",
"self",
",",
"new_name",
":",
"str",
")",
":",
"# TODO: check str 60 chars",
"await",
"self",
".",
"update",
"(",
"name",
"=",
"new_name",
")"
] | [
208,
4
] | [
221,
40
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.update_url | (self, new_url: str) |
|methcoro|
Args:
new_url: the url to be changed to (challonge.com/url - letters, numbers, and underscores only)
Raises:
APIException
| async def update_url(self, new_url: str):
"""
|methcoro|
Args:
new_url: the url to be changed to (challonge.com/url - letters, numbers, and underscores only)
Raises:
APIException
"""
# TODO: check format
await self.update(url=new_url) | [
"async",
"def",
"update_url",
"(",
"self",
",",
"new_url",
":",
"str",
")",
":",
"# TODO: check format",
"await",
"self",
".",
"update",
"(",
"url",
"=",
"new_url",
")"
] | [
223,
4
] | [
236,
38
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.update_subdomain | (self, new_subdomain: str) |
|methcoro|
Args:
new_subdomain: the subdomain to be changed to (subdomain.challonge.com/url - letters, numbers, and underscores only)
Raises:
APIException: if you don't have write access to this subdomain
| async def update_subdomain(self, new_subdomain: str):
"""
|methcoro|
Args:
new_subdomain: the subdomain to be changed to (subdomain.challonge.com/url - letters, numbers, and underscores only)
Raises:
APIException: if you don't have write access to this subdomai... | [
"async",
"def",
"update_subdomain",
"(",
"self",
",",
"new_subdomain",
":",
"str",
")",
":",
"# TODO: check format",
"await",
"self",
".",
"update",
"(",
"subdomain",
"=",
"new_subdomain",
")"
] | [
238,
4
] | [
251,
50
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.update_description | (self, new_description: str) |
|methcoro|
Args:
new_description: the description to be changed to
Raises:
APIException
| async def update_description(self, new_description: str):
"""
|methcoro|
Args:
new_description: the description to be changed to
Raises:
APIException
"""
await self.update(description=new_description) | [
"async",
"def",
"update_description",
"(",
"self",
",",
"new_description",
":",
"str",
")",
":",
"await",
"self",
".",
"update",
"(",
"description",
"=",
"new_description",
")"
] | [
253,
4
] | [
265,
54
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.allow_attachments | (self, allow: bool = True) | allow this tournament to accept attachments or not
|methcoro|
Args:
allow (default=True): False to disallow
Raises:
APIException
| allow this tournament to accept attachments or not | async def allow_attachments(self, allow: bool = True):
""" allow this tournament to accept attachments or not
|methcoro|
Args:
allow (default=True): False to disallow
Raises:
APIException
"""
await self.update(accept_attachments=allow) | [
"async",
"def",
"allow_attachments",
"(",
"self",
",",
"allow",
":",
"bool",
"=",
"True",
")",
":",
"await",
"self",
".",
"update",
"(",
"accept_attachments",
"=",
"allow",
")"
] | [
267,
4
] | [
279,
51
] | python | en | ['en', 'en', 'en'] | True |
Tournament.set_start_date | (self, date: str, time: str, check_in_duration: int = None) | set the tournament start date (and check in duration)
|methcoro|
Args:
date: fomatted date as YYYY/MM/DD (2017/02/14)
time: fromatted time as HH:MM (20:15)
check_in_duration (optional): duration in minutes
Raises:
APIException
| set the tournament start date (and check in duration) | async def set_start_date(self, date: str, time: str, check_in_duration: int = None):
""" set the tournament start date (and check in duration)
|methcoro|
Args:
date: fomatted date as YYYY/MM/DD (2017/02/14)
time: fromatted time as HH:MM (20:15)
check_in_dura... | [
"async",
"def",
"set_start_date",
"(",
"self",
",",
"date",
":",
"str",
",",
"time",
":",
"str",
",",
"check_in_duration",
":",
"int",
"=",
"None",
")",
":",
"date_time",
"=",
"datetime",
".",
"strptime",
"(",
"date",
"+",
"' '",
"+",
"time",
",",
"'... | [
281,
4
] | [
301,
36
] | python | en | ['en', 'en', 'en'] | True |
Tournament.update_double_elim_ending | (self, ending: DoubleEliminationEnding) | update the ending format for your Double Elimination tournament
|methcoro|
Args:
ending: choose between:\
* DoubleEliminationEnding.default: give the winners bracket finalist two chances to beat the losers bracket finalist
* DoubleEliminationEnding.single_match: c... | update the ending format for your Double Elimination tournament | async def update_double_elim_ending(self, ending: DoubleEliminationEnding):
""" update the ending format for your Double Elimination tournament
|methcoro|
Args:
ending: choose between:\
* DoubleEliminationEnding.default: give the winners bracket finalist two chances to... | [
"async",
"def",
"update_double_elim_ending",
"(",
"self",
",",
"ending",
":",
"DoubleEliminationEnding",
")",
":",
"await",
"self",
".",
"update",
"(",
"grand_finals_modifier",
"=",
"ending",
".",
"value",
")"
] | [
303,
4
] | [
318,
61
] | python | en | ['en', 'en', 'en'] | True |
Tournament.set_single_elim_third_place_match | (self, play_third_place_match: bool) |
|methcoro|
Args:
play_third_place_match: Include a match between semifinal losers if True
Raises:
APIException
| async def set_single_elim_third_place_match(self, play_third_place_match: bool):
"""
|methcoro|
Args:
play_third_place_match: Include a match between semifinal losers if True
Raises:
APIException
"""
await self.update(hold_third_place_match=pla... | [
"async",
"def",
"set_single_elim_third_place_match",
"(",
"self",
",",
"play_third_place_match",
":",
"bool",
")",
":",
"await",
"self",
".",
"update",
"(",
"hold_third_place_match",
"=",
"play_third_place_match",
")"
] | [
320,
4
] | [
332,
72
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.setup_swiss_points | (self, match_win: float = None, match_tie: float = None, game_win: float = None, game_tie: float = None, bye: float = None) |
|methcoro|
Args:
match_win
match_tie
game_win
game_tie
bye
Raises:
APIException
| async def setup_swiss_points(self, match_win: float = None, match_tie: float = None, game_win: float = None, game_tie: float = None, bye: float = None):
"""
|methcoro|
Args:
match_win
match_tie
game_win
game_tie
bye
Raises:
... | [
"async",
"def",
"setup_swiss_points",
"(",
"self",
",",
"match_win",
":",
"float",
"=",
"None",
",",
"match_tie",
":",
"float",
"=",
"None",
",",
"game_win",
":",
"float",
"=",
"None",
",",
"game_tie",
":",
"float",
"=",
"None",
",",
"bye",
":",
"float... | [
334,
4
] | [
362,
35
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.setup_swiss_rounds | (self, rounds_count: int) |
|methcoro|
Note:
|from_api| We recommend limiting the number of rounds to less than two-thirds the number of players. Otherwise, an impossible pairing situation can be reached and your tournament may end before the desired number of rounds are played.
Args:
rounds_cou... | async def setup_swiss_rounds(self, rounds_count: int):
"""
|methcoro|
Note:
|from_api| We recommend limiting the number of rounds to less than two-thirds the number of players. Otherwise, an impossible pairing situation can be reached and your tournament may end before the desired ... | [
"async",
"def",
"setup_swiss_rounds",
"(",
"self",
",",
"rounds_count",
":",
"int",
")",
":",
"await",
"self",
".",
"update",
"(",
"swiss_rounds",
"=",
"rounds_count",
")"
] | [
364,
4
] | [
379,
52
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.setup_round_robin_points | (self, match_win: float = None, match_tie: float = None, game_win: float = None, game_tie: float = None) |
|methcoro|
Args:
match_win
match_tie
game_win
game_tie
Raises:
APIException
| async def setup_round_robin_points(self, match_win: float = None, match_tie: float = None, game_win: float = None, game_tie: float = None):
"""
|methcoro|
Args:
match_win
match_tie
game_win
game_tie
Raises:
APIException
... | [
"async",
"def",
"setup_round_robin_points",
"(",
"self",
",",
"match_win",
":",
"float",
"=",
"None",
",",
"match_tie",
":",
"float",
"=",
"None",
",",
"game_win",
":",
"float",
"=",
"None",
",",
"game_tie",
":",
"float",
"=",
"None",
")",
":",
"params",... | [
381,
4
] | [
406,
35
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.update_notifications | (self, on_match_open: bool = None, on_tournament_end: bool = None) | update participants notifications for this tournament
|methcoro|
Args:
on_match_open: Email registered Challonge participants when matches open up for them
on_tournament_end: Email registered Challonge participants the results when this tournament ends
Raises:
... | update participants notifications for this tournament | async def update_notifications(self, on_match_open: bool = None, on_tournament_end: bool = None):
""" update participants notifications for this tournament
|methcoro|
Args:
on_match_open: Email registered Challonge participants when matches open up for them
on_tournamen... | [
"async",
"def",
"update_notifications",
"(",
"self",
",",
"on_match_open",
":",
"bool",
"=",
"None",
",",
"on_tournament_end",
":",
"bool",
"=",
"None",
")",
":",
"params",
"=",
"{",
"}",
"if",
"on_match_open",
"is",
"not",
"None",
":",
"params",
"[",
"'... | [
408,
4
] | [
427,
35
] | python | en | ['en', 'en', 'en'] | True |
Tournament.set_max_participants | (self, max_participants: int) |
|methcoro|
Args:
max_participants: Maximum number of participants in the bracket. A waiting list (attribute on Participant) will capture participants once the cap is reached.
Raises:
APIException
| async def set_max_participants(self, max_participants: int):
"""
|methcoro|
Args:
max_participants: Maximum number of participants in the bracket. A waiting list (attribute on Participant) will capture participants once the cap is reached.
Raises:
APIException
... | [
"async",
"def",
"set_max_participants",
"(",
"self",
",",
"max_participants",
":",
"int",
")",
":",
"await",
"self",
".",
"update",
"(",
"signup_cap",
"=",
"max_participants",
")"
] | [
429,
4
] | [
441,
54
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.set_private | (self, private: bool = True) | Hide this tournament from the public browsable index and your profile
|methcoro|
Args:
private:
Raises:
APIException
| Hide this tournament from the public browsable index and your profile | async def set_private(self, private: bool = True):
""" Hide this tournament from the public browsable index and your profile
|methcoro|
Args:
private:
Raises:
APIException
"""
await self.update(private=private) | [
"async",
"def",
"set_private",
"(",
"self",
",",
"private",
":",
"bool",
"=",
"True",
")",
":",
"await",
"self",
".",
"update",
"(",
"private",
"=",
"private",
")"
] | [
443,
4
] | [
455,
42
] | python | en | ['en', 'en', 'en'] | True |
Tournament.update_ranking_order | (self, order: RankingOrder) |
|methcoro|
Args:
order: see :class:`RankingOrder`
Raises:
APIException
| async def update_ranking_order(self, order: RankingOrder):
"""
|methcoro|
Args:
order: see :class:`RankingOrder`
Raises:
APIException
"""
await self.update(ranked_by=order.value) | [
"async",
"def",
"update_ranking_order",
"(",
"self",
",",
"order",
":",
"RankingOrder",
")",
":",
"await",
"self",
".",
"update",
"(",
"ranked_by",
"=",
"order",
".",
"value",
")"
] | [
457,
4
] | [
469,
48
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.update_website_options | (self, hide_forum: bool = None, show_rounds: bool = None, open_signup: bool = None) |
|methcoro|
Args:
hide_forum: Hide the forum tab on your Challonge page
show_rounds: Double Elimination only - Label each round above the bracket
open_signup: Have Challonge host a sign-up page (otherwise, you manually add all participants)
Raises:
... | async def update_website_options(self, hide_forum: bool = None, show_rounds: bool = None, open_signup: bool = None):
"""
|methcoro|
Args:
hide_forum: Hide the forum tab on your Challonge page
show_rounds: Double Elimination only - Label each round above the bracket
... | [
"async",
"def",
"update_website_options",
"(",
"self",
",",
"hide_forum",
":",
"bool",
"=",
"None",
",",
"show_rounds",
":",
"bool",
"=",
"None",
",",
"open_signup",
":",
"bool",
"=",
"None",
")",
":",
"params",
"=",
"{",
"}",
"if",
"hide_forum",
"is",
... | [
471,
4
] | [
493,
35
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.update_pairing_method | (self, pairing: Pairing) |
|methcoro|
Args:
pairing:
Raises:
APIException
| async def update_pairing_method(self, pairing: Pairing):
"""
|methcoro|
Args:
pairing:
Raises:
APIException
"""
do_sequential_pairing = pairing == Pairing.sequential
await self.update(sequential_pairings=do_sequential_pairing) | [
"async",
"def",
"update_pairing_method",
"(",
"self",
",",
"pairing",
":",
"Pairing",
")",
":",
"do_sequential_pairing",
"=",
"pairing",
"==",
"Pairing",
".",
"sequential",
"await",
"self",
".",
"update",
"(",
"sequential_pairings",
"=",
"do_sequential_pairing",
"... | [
495,
4
] | [
508,
68
] | python | en | ['en', 'error', 'th'] | False | |
Tournament.get_participant | (self, p_id: int, force_update=False) | get a participant by its id
|methcoro|
Args:
p_id: participant id
force_update (dfault=False): True to force an update to the Challonge API
Returns:
Participant: None if not found
Raises:
APIException
| get a participant by its id | async def get_participant(self, p_id: int, force_update=False) -> Participant:
""" get a participant by its id
|methcoro|
Args:
p_id: participant id
force_update (dfault=False): True to force an update to the Challonge API
Returns:
Participant: None... | [
"async",
"def",
"get_participant",
"(",
"self",
",",
"p_id",
":",
"int",
",",
"force_update",
"=",
"False",
")",
"->",
"Participant",
":",
"found_p",
"=",
"self",
".",
"_find_participant",
"(",
"p_id",
")",
"if",
"force_update",
"or",
"found_p",
"is",
"Non... | [
510,
4
] | [
530,
22
] | python | en | ['en', 'en', 'en'] | True |
Tournament.get_participants | (self, force_update=False) | get all participants
|methcoro|
Args:
force_update (default=False): True to force an update to the Challonge API
Returns:
list[Participant]:
Raises:
APIException
| get all participants | async def get_participants(self, force_update=False) -> list:
""" get all participants
|methcoro|
Args:
force_update (default=False): True to force an update to the Challonge API
Returns:
list[Participant]:
Raises:
APIException
"""... | [
"async",
"def",
"get_participants",
"(",
"self",
",",
"force_update",
"=",
"False",
")",
"->",
"list",
":",
"if",
"force_update",
"or",
"self",
".",
"participants",
"is",
"None",
":",
"res",
"=",
"await",
"self",
".",
"connection",
"(",
"'GET'",
",",
"'t... | [
532,
4
] | [
550,
38
] | python | en | ['en', 'ca', 'en'] | True |
Tournament.search_participant | (self, name, force_update=False) | search a participant by (display) name
|methcoro|
Args:
name: display name of the participant
force_update (dfault=False): True to force an update to the Challonge API
Returns:
Participant: None if not found
Raises:
APIException
... | search a participant by (display) name | async def search_participant(self, name, force_update=False):
""" search a participant by (display) name
|methcoro|
Args:
name: display name of the participant
force_update (dfault=False): True to force an update to the Challonge API
Returns:
Partic... | [
"async",
"def",
"search_participant",
"(",
"self",
",",
"name",
",",
"force_update",
"=",
"False",
")",
":",
"if",
"force_update",
"or",
"self",
".",
"participants",
"is",
"None",
":",
"await",
"self",
".",
"get_participants",
"(",
")",
"if",
"self",
".",
... | [
552,
4
] | [
574,
19
] | python | en | ['en', 'en', 'en'] | True |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.