id int32 0 252k | repo stringlengths 7 55 | path stringlengths 4 127 | func_name stringlengths 1 88 | original_string stringlengths 75 19.8k | language stringclasses 1
value | code stringlengths 75 19.8k | code_tokens list | docstring stringlengths 3 17.3k | docstring_tokens list | sha stringlengths 40 40 | url stringlengths 87 242 |
|---|---|---|---|---|---|---|---|---|---|---|---|
231,800 | pgjones/quart | quart/config.py | Config.from_pyfile | def from_pyfile(self, filename: str, silent: bool=False) -> None:
"""Load the configuration from a Python cfg or py file.
See Python's ConfigParser docs for details on the cfg format.
It is a common practice to load the defaults from the source
using the :meth:`from_object` and then ove... | python | def from_pyfile(self, filename: str, silent: bool=False) -> None:
"""Load the configuration from a Python cfg or py file.
See Python's ConfigParser docs for details on the cfg format.
It is a common practice to load the defaults from the source
using the :meth:`from_object` and then ove... | [
"def",
"from_pyfile",
"(",
"self",
",",
"filename",
":",
"str",
",",
"silent",
":",
"bool",
"=",
"False",
")",
"->",
"None",
":",
"file_path",
"=",
"self",
".",
"root_path",
"/",
"filename",
"try",
":",
"spec",
"=",
"importlib",
".",
"util",
".",
"sp... | Load the configuration from a Python cfg or py file.
See Python's ConfigParser docs for details on the cfg format.
It is a common practice to load the defaults from the source
using the :meth:`from_object` and then override with a cfg or
py file, for example
.. code-block:: pyt... | [
"Load",
"the",
"configuration",
"from",
"a",
"Python",
"cfg",
"or",
"py",
"file",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/config.py#L111-L145 |
231,801 | pgjones/quart | quart/config.py | Config.from_object | def from_object(self, instance: Union[object, str]) -> None:
"""Load the configuration from a Python object.
This can be used to reference modules or objects within
modules for example,
.. code-block:: python
app.config.from_object('module')
app.config.from_obj... | python | def from_object(self, instance: Union[object, str]) -> None:
"""Load the configuration from a Python object.
This can be used to reference modules or objects within
modules for example,
.. code-block:: python
app.config.from_object('module')
app.config.from_obj... | [
"def",
"from_object",
"(",
"self",
",",
"instance",
":",
"Union",
"[",
"object",
",",
"str",
"]",
")",
"->",
"None",
":",
"if",
"isinstance",
"(",
"instance",
",",
"str",
")",
":",
"try",
":",
"path",
",",
"config",
"=",
"instance",
".",
"rsplit",
... | Load the configuration from a Python object.
This can be used to reference modules or objects within
modules for example,
.. code-block:: python
app.config.from_object('module')
app.config.from_object('module.instance')
from module import instance
... | [
"Load",
"the",
"configuration",
"from",
"a",
"Python",
"object",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/config.py#L147-L179 |
231,802 | pgjones/quart | quart/config.py | Config.from_json | def from_json(self, filename: str, silent: bool=False) -> None:
"""Load the configuration values from a JSON formatted file.
This allows configuration to be loaded as so
.. code-block:: python
app.config.from_json('config.json')
Arguments:
filename: The filena... | python | def from_json(self, filename: str, silent: bool=False) -> None:
"""Load the configuration values from a JSON formatted file.
This allows configuration to be loaded as so
.. code-block:: python
app.config.from_json('config.json')
Arguments:
filename: The filena... | [
"def",
"from_json",
"(",
"self",
",",
"filename",
":",
"str",
",",
"silent",
":",
"bool",
"=",
"False",
")",
"->",
"None",
":",
"file_path",
"=",
"self",
".",
"root_path",
"/",
"filename",
"try",
":",
"with",
"open",
"(",
"file_path",
")",
"as",
"fil... | Load the configuration values from a JSON formatted file.
This allows configuration to be loaded as so
.. code-block:: python
app.config.from_json('config.json')
Arguments:
filename: The filename which when appended to
:attr:`root_path` gives the path ... | [
"Load",
"the",
"configuration",
"values",
"from",
"a",
"JSON",
"formatted",
"file",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/config.py#L181-L203 |
231,803 | pgjones/quart | quart/config.py | Config.from_mapping | def from_mapping(self, mapping: Optional[Mapping[str, Any]]=None, **kwargs: Any) -> None:
"""Load the configuration values from a mapping.
This allows either a mapping to be directly passed or as
keyword arguments, for example,
.. code-block:: python
config = {'FOO': 'bar'... | python | def from_mapping(self, mapping: Optional[Mapping[str, Any]]=None, **kwargs: Any) -> None:
"""Load the configuration values from a mapping.
This allows either a mapping to be directly passed or as
keyword arguments, for example,
.. code-block:: python
config = {'FOO': 'bar'... | [
"def",
"from_mapping",
"(",
"self",
",",
"mapping",
":",
"Optional",
"[",
"Mapping",
"[",
"str",
",",
"Any",
"]",
"]",
"=",
"None",
",",
"*",
"*",
"kwargs",
":",
"Any",
")",
"->",
"None",
":",
"mappings",
":",
"Dict",
"[",
"str",
",",
"Any",
"]",... | Load the configuration values from a mapping.
This allows either a mapping to be directly passed or as
keyword arguments, for example,
.. code-block:: python
config = {'FOO': 'bar'}
app.config.from_mapping(config)
app.config.form_mapping(FOO='bar')
... | [
"Load",
"the",
"configuration",
"values",
"from",
"a",
"mapping",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/config.py#L205-L228 |
231,804 | pgjones/quart | quart/config.py | Config.get_namespace | def get_namespace(
self,
namespace: str,
lowercase: bool=True,
trim_namespace: bool=True,
) -> Dict[str, Any]:
"""Return a dictionary of keys within a namespace.
A namespace is considered to be a key prefix, for example the
keys ``FOO_A, FOO_B... | python | def get_namespace(
self,
namespace: str,
lowercase: bool=True,
trim_namespace: bool=True,
) -> Dict[str, Any]:
"""Return a dictionary of keys within a namespace.
A namespace is considered to be a key prefix, for example the
keys ``FOO_A, FOO_B... | [
"def",
"get_namespace",
"(",
"self",
",",
"namespace",
":",
"str",
",",
"lowercase",
":",
"bool",
"=",
"True",
",",
"trim_namespace",
":",
"bool",
"=",
"True",
",",
")",
"->",
"Dict",
"[",
"str",
",",
"Any",
"]",
":",
"config",
"=",
"{",
"}",
"for"... | Return a dictionary of keys within a namespace.
A namespace is considered to be a key prefix, for example the
keys ``FOO_A, FOO_BAR, FOO_B`` are all within the ``FOO``
namespace. This method would return a dictionary with these
keys and values present.
.. code-block:: python
... | [
"Return",
"a",
"dictionary",
"of",
"keys",
"within",
"a",
"namespace",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/config.py#L230-L265 |
231,805 | pgjones/quart | quart/helpers.py | make_response | async def make_response(*args: Any) -> Response:
"""Create a response, a simple wrapper function.
This is most useful when you want to alter a Response before
returning it, for example
.. code-block:: python
response = make_response(render_template('index.html'))
response.headers['X-H... | python | async def make_response(*args: Any) -> Response:
"""Create a response, a simple wrapper function.
This is most useful when you want to alter a Response before
returning it, for example
.. code-block:: python
response = make_response(render_template('index.html'))
response.headers['X-H... | [
"async",
"def",
"make_response",
"(",
"*",
"args",
":",
"Any",
")",
"->",
"Response",
":",
"if",
"not",
"args",
":",
"return",
"current_app",
".",
"response_class",
"(",
")",
"if",
"len",
"(",
"args",
")",
"==",
"1",
":",
"args",
"=",
"args",
"[",
... | Create a response, a simple wrapper function.
This is most useful when you want to alter a Response before
returning it, for example
.. code-block:: python
response = make_response(render_template('index.html'))
response.headers['X-Header'] = 'Something' | [
"Create",
"a",
"response",
"a",
"simple",
"wrapper",
"function",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/helpers.py#L38-L55 |
231,806 | pgjones/quart | quart/helpers.py | get_flashed_messages | def get_flashed_messages(
with_categories: bool=False,
category_filter: List[str]=[],
) -> Union[List[str], List[Tuple[str, str]]]:
"""Retrieve the flashed messages stored in the session.
This is mostly useful in templates where it is exposed as a global
function, for example
.. code-b... | python | def get_flashed_messages(
with_categories: bool=False,
category_filter: List[str]=[],
) -> Union[List[str], List[Tuple[str, str]]]:
"""Retrieve the flashed messages stored in the session.
This is mostly useful in templates where it is exposed as a global
function, for example
.. code-b... | [
"def",
"get_flashed_messages",
"(",
"with_categories",
":",
"bool",
"=",
"False",
",",
"category_filter",
":",
"List",
"[",
"str",
"]",
"=",
"[",
"]",
",",
")",
"->",
"Union",
"[",
"List",
"[",
"str",
"]",
",",
"List",
"[",
"Tuple",
"[",
"str",
",",
... | Retrieve the flashed messages stored in the session.
This is mostly useful in templates where it is exposed as a global
function, for example
.. code-block:: html+jinja
<ul>
{% for message in get_flashed_messages() %}
<li>{{ message }}</li>
{% endfor %}
</ul>
... | [
"Retrieve",
"the",
"flashed",
"messages",
"stored",
"in",
"the",
"session",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/helpers.py#L95-L121 |
231,807 | pgjones/quart | quart/helpers.py | url_for | def url_for(
endpoint: str,
*,
_anchor: Optional[str]=None,
_external: Optional[bool]=None,
_method: Optional[str]=None,
_scheme: Optional[str]=None,
**values: Any,
) -> str:
"""Return the url for a specific endpoint.
This is most useful in templates and ... | python | def url_for(
endpoint: str,
*,
_anchor: Optional[str]=None,
_external: Optional[bool]=None,
_method: Optional[str]=None,
_scheme: Optional[str]=None,
**values: Any,
) -> str:
"""Return the url for a specific endpoint.
This is most useful in templates and ... | [
"def",
"url_for",
"(",
"endpoint",
":",
"str",
",",
"*",
",",
"_anchor",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",
",",
"_external",
":",
"Optional",
"[",
"bool",
"]",
"=",
"None",
",",
"_method",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",... | Return the url for a specific endpoint.
This is most useful in templates and redirects to create a URL
that can be used in the browser.
Arguments:
endpoint: The endpoint to build a url for, if prefixed with
``.`` it targets endpoint's in the current blueprint.
_anchor: Addition... | [
"Return",
"the",
"url",
"for",
"a",
"specific",
"endpoint",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/helpers.py#L137-L198 |
231,808 | pgjones/quart | quart/helpers.py | stream_with_context | def stream_with_context(func: Callable) -> Callable:
"""Share the current request context with a generator.
This allows the request context to be accessed within a streaming
generator, for example,
.. code-block:: python
@app.route('/')
def index() -> AsyncGenerator[bytes, None]:
... | python | def stream_with_context(func: Callable) -> Callable:
"""Share the current request context with a generator.
This allows the request context to be accessed within a streaming
generator, for example,
.. code-block:: python
@app.route('/')
def index() -> AsyncGenerator[bytes, None]:
... | [
"def",
"stream_with_context",
"(",
"func",
":",
"Callable",
")",
"->",
"Callable",
":",
"request_context",
"=",
"_request_ctx_stack",
".",
"top",
".",
"copy",
"(",
")",
"@",
"wraps",
"(",
"func",
")",
"async",
"def",
"generator",
"(",
"*",
"args",
":",
"... | Share the current request context with a generator.
This allows the request context to be accessed within a streaming
generator, for example,
.. code-block:: python
@app.route('/')
def index() -> AsyncGenerator[bytes, None]:
@stream_with_context
async def generator... | [
"Share",
"the",
"current",
"request",
"context",
"with",
"a",
"generator",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/helpers.py#L201-L227 |
231,809 | pgjones/quart | quart/static.py | safe_join | def safe_join(directory: FilePath, *paths: FilePath) -> Path:
"""Safely join the paths to the known directory to return a full path.
Raises:
NotFound: if the full path does not share a commonprefix with
the directory.
"""
try:
safe_path = file_path_to_path(directory).resolve(str... | python | def safe_join(directory: FilePath, *paths: FilePath) -> Path:
"""Safely join the paths to the known directory to return a full path.
Raises:
NotFound: if the full path does not share a commonprefix with
the directory.
"""
try:
safe_path = file_path_to_path(directory).resolve(str... | [
"def",
"safe_join",
"(",
"directory",
":",
"FilePath",
",",
"*",
"paths",
":",
"FilePath",
")",
"->",
"Path",
":",
"try",
":",
"safe_path",
"=",
"file_path_to_path",
"(",
"directory",
")",
".",
"resolve",
"(",
"strict",
"=",
"True",
")",
"full_path",
"="... | Safely join the paths to the known directory to return a full path.
Raises:
NotFound: if the full path does not share a commonprefix with
the directory. | [
"Safely",
"join",
"the",
"paths",
"to",
"the",
"known",
"directory",
"to",
"return",
"a",
"full",
"path",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/static.py#L117-L133 |
231,810 | pgjones/quart | quart/static.py | send_from_directory | async def send_from_directory(
directory: FilePath,
file_name: str,
*,
mimetype: Optional[str]=None,
as_attachment: bool=False,
attachment_filename: Optional[str]=None,
add_etags: bool=True,
cache_timeout: Optional[int]=None,
conditional: bool=True... | python | async def send_from_directory(
directory: FilePath,
file_name: str,
*,
mimetype: Optional[str]=None,
as_attachment: bool=False,
attachment_filename: Optional[str]=None,
add_etags: bool=True,
cache_timeout: Optional[int]=None,
conditional: bool=True... | [
"async",
"def",
"send_from_directory",
"(",
"directory",
":",
"FilePath",
",",
"file_name",
":",
"str",
",",
"*",
",",
"mimetype",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",
",",
"as_attachment",
":",
"bool",
"=",
"False",
",",
"attachment_filename",
"... | Send a file from a given directory.
Arguments:
directory: Directory that when combined with file_name gives
the file path.
file_name: File name that when combined with directory gives
the file path.
See :func:`send_file` for the other arguments. | [
"Send",
"a",
"file",
"from",
"a",
"given",
"directory",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/static.py#L136-L169 |
231,811 | pgjones/quart | quart/static.py | send_file | async def send_file(
filename: FilePath,
mimetype: Optional[str]=None,
as_attachment: bool=False,
attachment_filename: Optional[str]=None,
add_etags: bool=True,
cache_timeout: Optional[int]=None,
conditional: bool=False,
last_modified: Optional[datetime]=N... | python | async def send_file(
filename: FilePath,
mimetype: Optional[str]=None,
as_attachment: bool=False,
attachment_filename: Optional[str]=None,
add_etags: bool=True,
cache_timeout: Optional[int]=None,
conditional: bool=False,
last_modified: Optional[datetime]=N... | [
"async",
"def",
"send_file",
"(",
"filename",
":",
"FilePath",
",",
"mimetype",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",
",",
"as_attachment",
":",
"bool",
"=",
"False",
",",
"attachment_filename",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",
","... | Return a Reponse to send the filename given.
Arguments:
filename: The filename (path) to send, remember to use
:func:`safe_join`.
mimetype: Mimetype to use, by default it will be guessed or
revert to the DEFAULT_MIMETYPE.
as_attachment: If true use the attachment fil... | [
"Return",
"a",
"Reponse",
"to",
"send",
"the",
"filename",
"given",
"."
] | 7cb2d3bd98e8746025764f2b933abc12041fa175 | https://github.com/pgjones/quart/blob/7cb2d3bd98e8746025764f2b933abc12041fa175/quart/static.py#L172-L230 |
231,812 | manrajgrover/halo | halo/halo.py | Halo._render_frame | def _render_frame(self):
"""Renders the frame on the line after clearing it.
"""
frame = self.frame()
output = '\r{0}'.format(frame)
self.clear()
try:
self._stream.write(output)
except UnicodeEncodeError:
self._stream.write(encode_utf_8_tex... | python | def _render_frame(self):
"""Renders the frame on the line after clearing it.
"""
frame = self.frame()
output = '\r{0}'.format(frame)
self.clear()
try:
self._stream.write(output)
except UnicodeEncodeError:
self._stream.write(encode_utf_8_tex... | [
"def",
"_render_frame",
"(",
"self",
")",
":",
"frame",
"=",
"self",
".",
"frame",
"(",
")",
"output",
"=",
"'\\r{0}'",
".",
"format",
"(",
"frame",
")",
"self",
".",
"clear",
"(",
")",
"try",
":",
"self",
".",
"_stream",
".",
"write",
"(",
"output... | Renders the frame on the line after clearing it. | [
"Renders",
"the",
"frame",
"on",
"the",
"line",
"after",
"clearing",
"it",
"."
] | 0ac5149dea965b27b09f0776df9095ebf013fb4d | https://github.com/manrajgrover/halo/blob/0ac5149dea965b27b09f0776df9095ebf013fb4d/halo/halo.py#L336-L345 |
231,813 | manrajgrover/halo | halo/_utils.py | get_environment | def get_environment():
"""Get the environment in which halo is running
Returns
-------
str
Environment name
"""
try:
from IPython import get_ipython
except ImportError:
return 'terminal'
try:
shell = get_ipython().__class__.__name__
if shell == ... | python | def get_environment():
"""Get the environment in which halo is running
Returns
-------
str
Environment name
"""
try:
from IPython import get_ipython
except ImportError:
return 'terminal'
try:
shell = get_ipython().__class__.__name__
if shell == ... | [
"def",
"get_environment",
"(",
")",
":",
"try",
":",
"from",
"IPython",
"import",
"get_ipython",
"except",
"ImportError",
":",
"return",
"'terminal'",
"try",
":",
"shell",
"=",
"get_ipython",
"(",
")",
".",
"__class__",
".",
"__name__",
"if",
"shell",
"==",
... | Get the environment in which halo is running
Returns
-------
str
Environment name | [
"Get",
"the",
"environment",
"in",
"which",
"halo",
"is",
"running"
] | 0ac5149dea965b27b09f0776df9095ebf013fb4d | https://github.com/manrajgrover/halo/blob/0ac5149dea965b27b09f0776df9095ebf013fb4d/halo/_utils.py#L35-L59 |
231,814 | manrajgrover/halo | halo/_utils.py | is_text_type | def is_text_type(text):
"""Check if given parameter is a string or not
Parameters
----------
text : *
Parameter to be checked for text type
Returns
-------
bool
Whether parameter is a string or not
"""
if isinstance(text, six.text_type) or isinstance(text, six.strin... | python | def is_text_type(text):
"""Check if given parameter is a string or not
Parameters
----------
text : *
Parameter to be checked for text type
Returns
-------
bool
Whether parameter is a string or not
"""
if isinstance(text, six.text_type) or isinstance(text, six.strin... | [
"def",
"is_text_type",
"(",
"text",
")",
":",
"if",
"isinstance",
"(",
"text",
",",
"six",
".",
"text_type",
")",
"or",
"isinstance",
"(",
"text",
",",
"six",
".",
"string_types",
")",
":",
"return",
"True",
"return",
"False"
] | Check if given parameter is a string or not
Parameters
----------
text : *
Parameter to be checked for text type
Returns
-------
bool
Whether parameter is a string or not | [
"Check",
"if",
"given",
"parameter",
"is",
"a",
"string",
"or",
"not"
] | 0ac5149dea965b27b09f0776df9095ebf013fb4d | https://github.com/manrajgrover/halo/blob/0ac5149dea965b27b09f0776df9095ebf013fb4d/halo/_utils.py#L80-L96 |
231,815 | GibbsConsulting/django-plotly-dash | django_plotly_dash/models.py | find_stateless_by_name | def find_stateless_by_name(name):
'''
Find stateless app given its name
First search the Django ORM, and if not found then look the app up in a local registry.
If the app does not have an ORM entry then a StatelessApp model instance is created.
'''
try:
dsa_app = StatelessApp.objects.ge... | python | def find_stateless_by_name(name):
'''
Find stateless app given its name
First search the Django ORM, and if not found then look the app up in a local registry.
If the app does not have an ORM entry then a StatelessApp model instance is created.
'''
try:
dsa_app = StatelessApp.objects.ge... | [
"def",
"find_stateless_by_name",
"(",
"name",
")",
":",
"try",
":",
"dsa_app",
"=",
"StatelessApp",
".",
"objects",
".",
"get",
"(",
"app_name",
"=",
"name",
")",
"# pylint: disable=no-member",
"return",
"dsa_app",
".",
"as_dash_app",
"(",
")",
"except",
":",
... | Find stateless app given its name
First search the Django ORM, and if not found then look the app up in a local registry.
If the app does not have an ORM entry then a StatelessApp model instance is created. | [
"Find",
"stateless",
"app",
"given",
"its",
"name"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/models.py#L63-L79 |
231,816 | GibbsConsulting/django-plotly-dash | django_plotly_dash/models.py | StatelessApp.as_dash_app | def as_dash_app(self):
'''
Return a DjangoDash instance of the dash application
'''
dateless_dash_app = getattr(self, '_stateless_dash_app_instance', None)
if not dateless_dash_app:
dateless_dash_app = get_stateless_by_name(self.app_name)
setattr(self, '_s... | python | def as_dash_app(self):
'''
Return a DjangoDash instance of the dash application
'''
dateless_dash_app = getattr(self, '_stateless_dash_app_instance', None)
if not dateless_dash_app:
dateless_dash_app = get_stateless_by_name(self.app_name)
setattr(self, '_s... | [
"def",
"as_dash_app",
"(",
"self",
")",
":",
"dateless_dash_app",
"=",
"getattr",
"(",
"self",
",",
"'_stateless_dash_app_instance'",
",",
"None",
")",
"if",
"not",
"dateless_dash_app",
":",
"dateless_dash_app",
"=",
"get_stateless_by_name",
"(",
"self",
".",
"app... | Return a DjangoDash instance of the dash application | [
"Return",
"a",
"DjangoDash",
"instance",
"of",
"the",
"dash",
"application"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/models.py#L53-L61 |
231,817 | GibbsConsulting/django-plotly-dash | django_plotly_dash/models.py | DashApp.handle_current_state | def handle_current_state(self):
'''
Check to see if the current hydrated state and the saved state are different.
If they are, then persist the current state in the database by saving the model instance.
'''
if getattr(self, '_current_state_hydrated_changed', False) and self.sav... | python | def handle_current_state(self):
'''
Check to see if the current hydrated state and the saved state are different.
If they are, then persist the current state in the database by saving the model instance.
'''
if getattr(self, '_current_state_hydrated_changed', False) and self.sav... | [
"def",
"handle_current_state",
"(",
"self",
")",
":",
"if",
"getattr",
"(",
"self",
",",
"'_current_state_hydrated_changed'",
",",
"False",
")",
"and",
"self",
".",
"save_on_change",
":",
"new_base_state",
"=",
"json",
".",
"dumps",
"(",
"getattr",
"(",
"self"... | Check to see if the current hydrated state and the saved state are different.
If they are, then persist the current state in the database by saving the model instance. | [
"Check",
"to",
"see",
"if",
"the",
"current",
"hydrated",
"state",
"and",
"the",
"saved",
"state",
"are",
"different",
"."
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/models.py#L114-L124 |
231,818 | GibbsConsulting/django-plotly-dash | django_plotly_dash/models.py | DashApp.have_current_state_entry | def have_current_state_entry(self, wid, key):
'Return True if there is a cached current state for this app'
cscoll = self.current_state()
c_state = cscoll.get(wid, {})
return key in c_state | python | def have_current_state_entry(self, wid, key):
'Return True if there is a cached current state for this app'
cscoll = self.current_state()
c_state = cscoll.get(wid, {})
return key in c_state | [
"def",
"have_current_state_entry",
"(",
"self",
",",
"wid",
",",
"key",
")",
":",
"cscoll",
"=",
"self",
".",
"current_state",
"(",
")",
"c_state",
"=",
"cscoll",
".",
"get",
"(",
"wid",
",",
"{",
"}",
")",
"return",
"key",
"in",
"c_state"
] | Return True if there is a cached current state for this app | [
"Return",
"True",
"if",
"there",
"is",
"a",
"cached",
"current",
"state",
"for",
"this",
"app"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/models.py#L126-L130 |
231,819 | GibbsConsulting/django-plotly-dash | django_plotly_dash/models.py | DashApp.current_state | def current_state(self):
'''
Return the current internal state of the model instance.
This is not necessarily the same as the persisted state
stored in the self.base_state variable.
'''
c_state = getattr(self, '_current_state_hydrated', None)
if not c_state:
... | python | def current_state(self):
'''
Return the current internal state of the model instance.
This is not necessarily the same as the persisted state
stored in the self.base_state variable.
'''
c_state = getattr(self, '_current_state_hydrated', None)
if not c_state:
... | [
"def",
"current_state",
"(",
"self",
")",
":",
"c_state",
"=",
"getattr",
"(",
"self",
",",
"'_current_state_hydrated'",
",",
"None",
")",
"if",
"not",
"c_state",
":",
"c_state",
"=",
"json",
".",
"loads",
"(",
"self",
".",
"base_state",
")",
"setattr",
... | Return the current internal state of the model instance.
This is not necessarily the same as the persisted state
stored in the self.base_state variable. | [
"Return",
"the",
"current",
"internal",
"state",
"of",
"the",
"model",
"instance",
"."
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/models.py#L146-L158 |
231,820 | GibbsConsulting/django-plotly-dash | django_plotly_dash/models.py | DashApp.as_dash_instance | def as_dash_instance(self, cache_id=None):
'Return a dash application instance for this model instance'
dash_app = self.stateless_app.as_dash_app() # pylint: disable=no-member
base = self.current_state()
return dash_app.do_form_dash_instance(replacements=base,
... | python | def as_dash_instance(self, cache_id=None):
'Return a dash application instance for this model instance'
dash_app = self.stateless_app.as_dash_app() # pylint: disable=no-member
base = self.current_state()
return dash_app.do_form_dash_instance(replacements=base,
... | [
"def",
"as_dash_instance",
"(",
"self",
",",
"cache_id",
"=",
"None",
")",
":",
"dash_app",
"=",
"self",
".",
"stateless_app",
".",
"as_dash_app",
"(",
")",
"# pylint: disable=no-member",
"base",
"=",
"self",
".",
"current_state",
"(",
")",
"return",
"dash_app... | Return a dash application instance for this model instance | [
"Return",
"a",
"dash",
"application",
"instance",
"for",
"this",
"model",
"instance"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/models.py#L160-L166 |
231,821 | GibbsConsulting/django-plotly-dash | django_plotly_dash/models.py | DashApp._get_base_state | def _get_base_state(self):
'''
Get the base state of the object, as defined by the app.layout code, as a python dict
'''
base_app_inst = self.stateless_app.as_dash_app().as_dash_instance() # pylint: disable=no-member
# Get base layout response, from a base object
base_re... | python | def _get_base_state(self):
'''
Get the base state of the object, as defined by the app.layout code, as a python dict
'''
base_app_inst = self.stateless_app.as_dash_app().as_dash_instance() # pylint: disable=no-member
# Get base layout response, from a base object
base_re... | [
"def",
"_get_base_state",
"(",
"self",
")",
":",
"base_app_inst",
"=",
"self",
".",
"stateless_app",
".",
"as_dash_app",
"(",
")",
".",
"as_dash_instance",
"(",
")",
"# pylint: disable=no-member",
"# Get base layout response, from a base object",
"base_resp",
"=",
"base... | Get the base state of the object, as defined by the app.layout code, as a python dict | [
"Get",
"the",
"base",
"state",
"of",
"the",
"object",
"as",
"defined",
"by",
"the",
"app",
".",
"layout",
"code",
"as",
"a",
"python",
"dict"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/models.py#L168-L182 |
231,822 | GibbsConsulting/django-plotly-dash | django_plotly_dash/models.py | DashApp.populate_values | def populate_values(self):
'''
Add values from the underlying dash layout configuration
'''
obj = self._get_base_state()
self.base_state = json.dumps(obj) | python | def populate_values(self):
'''
Add values from the underlying dash layout configuration
'''
obj = self._get_base_state()
self.base_state = json.dumps(obj) | [
"def",
"populate_values",
"(",
"self",
")",
":",
"obj",
"=",
"self",
".",
"_get_base_state",
"(",
")",
"self",
".",
"base_state",
"=",
"json",
".",
"dumps",
"(",
"obj",
")"
] | Add values from the underlying dash layout configuration | [
"Add",
"values",
"from",
"the",
"underlying",
"dash",
"layout",
"configuration"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/models.py#L184-L189 |
231,823 | GibbsConsulting/django-plotly-dash | django_plotly_dash/models.py | DashApp.locate_item | def locate_item(ident, stateless=False, cache_id=None):
'''Locate a dash application, given either the
slug of an instance or the name for a stateless app'''
if stateless:
dash_app = find_stateless_by_name(ident)
else:
dash_app = get_object_or_404(DashApp, slug=id... | python | def locate_item(ident, stateless=False, cache_id=None):
'''Locate a dash application, given either the
slug of an instance or the name for a stateless app'''
if stateless:
dash_app = find_stateless_by_name(ident)
else:
dash_app = get_object_or_404(DashApp, slug=id... | [
"def",
"locate_item",
"(",
"ident",
",",
"stateless",
"=",
"False",
",",
"cache_id",
"=",
"None",
")",
":",
"if",
"stateless",
":",
"dash_app",
"=",
"find_stateless_by_name",
"(",
"ident",
")",
"else",
":",
"dash_app",
"=",
"get_object_or_404",
"(",
"DashApp... | Locate a dash application, given either the
slug of an instance or the name for a stateless app | [
"Locate",
"a",
"dash",
"application",
"given",
"either",
"the",
"slug",
"of",
"an",
"instance",
"or",
"the",
"name",
"for",
"a",
"stateless",
"app"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/models.py#L192-L201 |
231,824 | GibbsConsulting/django-plotly-dash | django_plotly_dash/consumers.py | send_to_pipe_channel | def send_to_pipe_channel(channel_name,
label,
value):
'Send message through pipe to client component'
async_to_sync(async_send_to_pipe_channel)(channel_name=channel_name,
label=label,
... | python | def send_to_pipe_channel(channel_name,
label,
value):
'Send message through pipe to client component'
async_to_sync(async_send_to_pipe_channel)(channel_name=channel_name,
label=label,
... | [
"def",
"send_to_pipe_channel",
"(",
"channel_name",
",",
"label",
",",
"value",
")",
":",
"async_to_sync",
"(",
"async_send_to_pipe_channel",
")",
"(",
"channel_name",
"=",
"channel_name",
",",
"label",
"=",
"label",
",",
"value",
"=",
"value",
")"
] | Send message through pipe to client component | [
"Send",
"message",
"through",
"pipe",
"to",
"client",
"component"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/consumers.py#L35-L41 |
231,825 | GibbsConsulting/django-plotly-dash | django_plotly_dash/consumers.py | async_send_to_pipe_channel | async def async_send_to_pipe_channel(channel_name,
label,
value):
'Send message asynchronously through pipe to client component'
pcn = _form_pipe_channel_name(channel_name)
channel_layer = get_channel_layer()
await channel_layer.... | python | async def async_send_to_pipe_channel(channel_name,
label,
value):
'Send message asynchronously through pipe to client component'
pcn = _form_pipe_channel_name(channel_name)
channel_layer = get_channel_layer()
await channel_layer.... | [
"async",
"def",
"async_send_to_pipe_channel",
"(",
"channel_name",
",",
"label",
",",
"value",
")",
":",
"pcn",
"=",
"_form_pipe_channel_name",
"(",
"channel_name",
")",
"channel_layer",
"=",
"get_channel_layer",
"(",
")",
"await",
"channel_layer",
".",
"group_send"... | Send message asynchronously through pipe to client component | [
"Send",
"message",
"asynchronously",
"through",
"pipe",
"to",
"client",
"component"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/consumers.py#L43-L53 |
231,826 | GibbsConsulting/django-plotly-dash | django_plotly_dash/consumers.py | MessageConsumer.pipe_value | def pipe_value(self, message):
'Send a new value into the ws pipe'
jmsg = json.dumps(message)
self.send(jmsg) | python | def pipe_value(self, message):
'Send a new value into the ws pipe'
jmsg = json.dumps(message)
self.send(jmsg) | [
"def",
"pipe_value",
"(",
"self",
",",
"message",
")",
":",
"jmsg",
"=",
"json",
".",
"dumps",
"(",
"message",
")",
"self",
".",
"send",
"(",
"jmsg",
")"
] | Send a new value into the ws pipe | [
"Send",
"a",
"new",
"value",
"into",
"the",
"ws",
"pipe"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/consumers.py#L72-L75 |
231,827 | GibbsConsulting/django-plotly-dash | django_plotly_dash/consumers.py | MessageConsumer.update_pipe_channel | def update_pipe_channel(self, uid, channel_name, label): # pylint: disable=unused-argument
'''
Update this consumer to listen on channel_name for the js widget associated with uid
'''
pipe_group_name = _form_pipe_channel_name(channel_name)
if self.channel_layer:
curr... | python | def update_pipe_channel(self, uid, channel_name, label): # pylint: disable=unused-argument
'''
Update this consumer to listen on channel_name for the js widget associated with uid
'''
pipe_group_name = _form_pipe_channel_name(channel_name)
if self.channel_layer:
curr... | [
"def",
"update_pipe_channel",
"(",
"self",
",",
"uid",
",",
"channel_name",
",",
"label",
")",
":",
"# pylint: disable=unused-argument",
"pipe_group_name",
"=",
"_form_pipe_channel_name",
"(",
"channel_name",
")",
"if",
"self",
".",
"channel_layer",
":",
"current",
... | Update this consumer to listen on channel_name for the js widget associated with uid | [
"Update",
"this",
"consumer",
"to",
"listen",
"on",
"channel_name",
"for",
"the",
"js",
"widget",
"associated",
"with",
"uid"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/consumers.py#L77-L90 |
231,828 | GibbsConsulting/django-plotly-dash | django_plotly_dash/util.py | store_initial_arguments | def store_initial_arguments(request, initial_arguments=None):
'Store initial arguments, if any, and return a cache identifier'
if initial_arguments is None:
return None
# Generate a cache id
cache_id = "dpd-initial-args-%s" % str(uuid.uuid4()).replace('-', '')
# Store args in json form in... | python | def store_initial_arguments(request, initial_arguments=None):
'Store initial arguments, if any, and return a cache identifier'
if initial_arguments is None:
return None
# Generate a cache id
cache_id = "dpd-initial-args-%s" % str(uuid.uuid4()).replace('-', '')
# Store args in json form in... | [
"def",
"store_initial_arguments",
"(",
"request",
",",
"initial_arguments",
"=",
"None",
")",
":",
"if",
"initial_arguments",
"is",
"None",
":",
"return",
"None",
"# Generate a cache id",
"cache_id",
"=",
"\"dpd-initial-args-%s\"",
"%",
"str",
"(",
"uuid",
".",
"u... | Store initial arguments, if any, and return a cache identifier | [
"Store",
"initial",
"arguments",
"if",
"any",
"and",
"return",
"a",
"cache",
"identifier"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/util.py#L72-L87 |
231,829 | GibbsConsulting/django-plotly-dash | django_plotly_dash/util.py | get_initial_arguments | def get_initial_arguments(request, cache_id=None):
'Extract initial arguments for the dash app'
if cache_id is None:
return None
if initial_argument_location():
return cache.get(cache_id)
return request.session[cache_id] | python | def get_initial_arguments(request, cache_id=None):
'Extract initial arguments for the dash app'
if cache_id is None:
return None
if initial_argument_location():
return cache.get(cache_id)
return request.session[cache_id] | [
"def",
"get_initial_arguments",
"(",
"request",
",",
"cache_id",
"=",
"None",
")",
":",
"if",
"cache_id",
"is",
"None",
":",
"return",
"None",
"if",
"initial_argument_location",
"(",
")",
":",
"return",
"cache",
".",
"get",
"(",
"cache_id",
")",
"return",
... | Extract initial arguments for the dash app | [
"Extract",
"initial",
"arguments",
"for",
"the",
"dash",
"app"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/util.py#L89-L98 |
231,830 | GibbsConsulting/django-plotly-dash | django_plotly_dash/views.py | dependencies | def dependencies(request, ident, stateless=False, **kwargs):
'Return the dependencies'
_, app = DashApp.locate_item(ident, stateless)
with app.app_context():
view_func = app.locate_endpoint_function('dash-dependencies')
resp = view_func()
return HttpResponse(resp.data,
... | python | def dependencies(request, ident, stateless=False, **kwargs):
'Return the dependencies'
_, app = DashApp.locate_item(ident, stateless)
with app.app_context():
view_func = app.locate_endpoint_function('dash-dependencies')
resp = view_func()
return HttpResponse(resp.data,
... | [
"def",
"dependencies",
"(",
"request",
",",
"ident",
",",
"stateless",
"=",
"False",
",",
"*",
"*",
"kwargs",
")",
":",
"_",
",",
"app",
"=",
"DashApp",
".",
"locate_item",
"(",
"ident",
",",
"stateless",
")",
"with",
"app",
".",
"app_context",
"(",
... | Return the dependencies | [
"Return",
"the",
"dependencies"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/views.py#L39-L47 |
231,831 | GibbsConsulting/django-plotly-dash | django_plotly_dash/views.py | layout | def layout(request, ident, stateless=False, cache_id=None, **kwargs):
'Return the layout of the dash application'
_, app = DashApp.locate_item(ident, stateless)
view_func = app.locate_endpoint_function('dash-layout')
resp = view_func()
initial_arguments = get_initial_arguments(request, cache_id)
... | python | def layout(request, ident, stateless=False, cache_id=None, **kwargs):
'Return the layout of the dash application'
_, app = DashApp.locate_item(ident, stateless)
view_func = app.locate_endpoint_function('dash-layout')
resp = view_func()
initial_arguments = get_initial_arguments(request, cache_id)
... | [
"def",
"layout",
"(",
"request",
",",
"ident",
",",
"stateless",
"=",
"False",
",",
"cache_id",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"_",
",",
"app",
"=",
"DashApp",
".",
"locate_item",
"(",
"ident",
",",
"stateless",
")",
"view_func",
"="... | Return the layout of the dash application | [
"Return",
"the",
"layout",
"of",
"the",
"dash",
"application"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/views.py#L49-L60 |
231,832 | GibbsConsulting/django-plotly-dash | django_plotly_dash/views.py | update | def update(request, ident, stateless=False, **kwargs):
'Generate update json response'
dash_app, app = DashApp.locate_item(ident, stateless)
request_body = json.loads(request.body.decode('utf-8'))
if app.use_dash_dispatch():
# Force call through dash
view_func = app.locate_endpoint_fun... | python | def update(request, ident, stateless=False, **kwargs):
'Generate update json response'
dash_app, app = DashApp.locate_item(ident, stateless)
request_body = json.loads(request.body.decode('utf-8'))
if app.use_dash_dispatch():
# Force call through dash
view_func = app.locate_endpoint_fun... | [
"def",
"update",
"(",
"request",
",",
"ident",
",",
"stateless",
"=",
"False",
",",
"*",
"*",
"kwargs",
")",
":",
"dash_app",
",",
"app",
"=",
"DashApp",
".",
"locate_item",
"(",
"ident",
",",
"stateless",
")",
"request_body",
"=",
"json",
".",
"loads"... | Generate update json response | [
"Generate",
"update",
"json",
"response"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/views.py#L62-L102 |
231,833 | GibbsConsulting/django-plotly-dash | django_plotly_dash/views.py | main_view | def main_view(request, ident, stateless=False, cache_id=None, **kwargs):
'Main view for a dash app'
_, app = DashApp.locate_item(ident, stateless, cache_id=cache_id)
view_func = app.locate_endpoint_function()
resp = view_func()
return HttpResponse(resp) | python | def main_view(request, ident, stateless=False, cache_id=None, **kwargs):
'Main view for a dash app'
_, app = DashApp.locate_item(ident, stateless, cache_id=cache_id)
view_func = app.locate_endpoint_function()
resp = view_func()
return HttpResponse(resp) | [
"def",
"main_view",
"(",
"request",
",",
"ident",
",",
"stateless",
"=",
"False",
",",
"cache_id",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"_",
",",
"app",
"=",
"DashApp",
".",
"locate_item",
"(",
"ident",
",",
"stateless",
",",
"cache_id",
"... | Main view for a dash app | [
"Main",
"view",
"for",
"a",
"dash",
"app"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/views.py#L104-L110 |
231,834 | GibbsConsulting/django-plotly-dash | django_plotly_dash/views.py | app_assets | def app_assets(request, **kwargs):
'Return a local dash app asset, served up through the Django static framework'
get_params = request.GET.urlencode()
extra_part = ""
if get_params:
redone_url = "/static/dash/assets/%s?%s" %(extra_part, get_params)
else:
redone_url = "/static/dash/as... | python | def app_assets(request, **kwargs):
'Return a local dash app asset, served up through the Django static framework'
get_params = request.GET.urlencode()
extra_part = ""
if get_params:
redone_url = "/static/dash/assets/%s?%s" %(extra_part, get_params)
else:
redone_url = "/static/dash/as... | [
"def",
"app_assets",
"(",
"request",
",",
"*",
"*",
"kwargs",
")",
":",
"get_params",
"=",
"request",
".",
"GET",
".",
"urlencode",
"(",
")",
"extra_part",
"=",
"\"\"",
"if",
"get_params",
":",
"redone_url",
"=",
"\"/static/dash/assets/%s?%s\"",
"%",
"(",
... | Return a local dash app asset, served up through the Django static framework | [
"Return",
"a",
"local",
"dash",
"app",
"asset",
"served",
"up",
"through",
"the",
"Django",
"static",
"framework"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/views.py#L131-L140 |
231,835 | GibbsConsulting/django-plotly-dash | django_plotly_dash/views.py | add_to_session | def add_to_session(request, template_name="index.html", **kwargs):
'Add some info to a session in a place that django-plotly-dash can pass to a callback'
django_plotly_dash = request.session.get("django_plotly_dash", dict())
session_add_count = django_plotly_dash.get('add_counter', 0)
django_plotly_da... | python | def add_to_session(request, template_name="index.html", **kwargs):
'Add some info to a session in a place that django-plotly-dash can pass to a callback'
django_plotly_dash = request.session.get("django_plotly_dash", dict())
session_add_count = django_plotly_dash.get('add_counter', 0)
django_plotly_da... | [
"def",
"add_to_session",
"(",
"request",
",",
"template_name",
"=",
"\"index.html\"",
",",
"*",
"*",
"kwargs",
")",
":",
"django_plotly_dash",
"=",
"request",
".",
"session",
".",
"get",
"(",
"\"django_plotly_dash\"",
",",
"dict",
"(",
")",
")",
"session_add_c... | Add some info to a session in a place that django-plotly-dash can pass to a callback | [
"Add",
"some",
"info",
"to",
"a",
"session",
"in",
"a",
"place",
"that",
"django",
"-",
"plotly",
"-",
"dash",
"can",
"pass",
"to",
"a",
"callback"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/views.py#L145-L154 |
231,836 | GibbsConsulting/django-plotly-dash | django_plotly_dash/views.py | asset_redirection | def asset_redirection(request, path, ident=None, stateless=False, **kwargs):
'Redirect static assets for a component'
X, app = DashApp.locate_item(ident, stateless)
# Redirect to a location based on the import path of the module containing the DjangoDash app
static_path = X.get_asset_static_url(path)
... | python | def asset_redirection(request, path, ident=None, stateless=False, **kwargs):
'Redirect static assets for a component'
X, app = DashApp.locate_item(ident, stateless)
# Redirect to a location based on the import path of the module containing the DjangoDash app
static_path = X.get_asset_static_url(path)
... | [
"def",
"asset_redirection",
"(",
"request",
",",
"path",
",",
"ident",
"=",
"None",
",",
"stateless",
"=",
"False",
",",
"*",
"*",
"kwargs",
")",
":",
"X",
",",
"app",
"=",
"DashApp",
".",
"locate_item",
"(",
"ident",
",",
"stateless",
")",
"# Redirect... | Redirect static assets for a component | [
"Redirect",
"static",
"assets",
"for",
"a",
"component"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/views.py#L156-L164 |
231,837 | GibbsConsulting/django-plotly-dash | demo/demo/views.py | dash_example_1_view | def dash_example_1_view(request, template_name="demo_six.html", **kwargs):
'Example view that inserts content into the dash context passed to the dash application'
context = {}
# create some context to send over to Dash:
dash_context = request.session.get("django_plotly_dash", dict())
dash_context... | python | def dash_example_1_view(request, template_name="demo_six.html", **kwargs):
'Example view that inserts content into the dash context passed to the dash application'
context = {}
# create some context to send over to Dash:
dash_context = request.session.get("django_plotly_dash", dict())
dash_context... | [
"def",
"dash_example_1_view",
"(",
"request",
",",
"template_name",
"=",
"\"demo_six.html\"",
",",
"*",
"*",
"kwargs",
")",
":",
"context",
"=",
"{",
"}",
"# create some context to send over to Dash:",
"dash_context",
"=",
"request",
".",
"session",
".",
"get",
"(... | Example view that inserts content into the dash context passed to the dash application | [
"Example",
"view",
"that",
"inserts",
"content",
"into",
"the",
"dash",
"context",
"passed",
"to",
"the",
"dash",
"application"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/demo/demo/views.py#L9-L19 |
231,838 | GibbsConsulting/django-plotly-dash | demo/demo/views.py | session_state_view | def session_state_view(request, template_name, **kwargs):
'Example view that exhibits the use of sessions to store state'
session = request.session
demo_count = session.get('django_plotly_dash', {})
ind_use = demo_count.get('ind_use', 0)
ind_use += 1
demo_count['ind_use'] = ind_use
conte... | python | def session_state_view(request, template_name, **kwargs):
'Example view that exhibits the use of sessions to store state'
session = request.session
demo_count = session.get('django_plotly_dash', {})
ind_use = demo_count.get('ind_use', 0)
ind_use += 1
demo_count['ind_use'] = ind_use
conte... | [
"def",
"session_state_view",
"(",
"request",
",",
"template_name",
",",
"*",
"*",
"kwargs",
")",
":",
"session",
"=",
"request",
".",
"session",
"demo_count",
"=",
"session",
".",
"get",
"(",
"'django_plotly_dash'",
",",
"{",
"}",
")",
"ind_use",
"=",
"dem... | Example view that exhibits the use of sessions to store state | [
"Example",
"view",
"that",
"exhibits",
"the",
"use",
"of",
"sessions",
"to",
"store",
"state"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/demo/demo/views.py#L21-L36 |
231,839 | GibbsConsulting/django-plotly-dash | django_plotly_dash/middleware.py | ContentCollector.adjust_response | def adjust_response(self, response):
'Locate placeholder magic strings and replace with content'
try:
c1 = self._replace(response.content,
self.header_placeholder,
self.embedded_holder.css)
response.content = self._r... | python | def adjust_response(self, response):
'Locate placeholder magic strings and replace with content'
try:
c1 = self._replace(response.content,
self.header_placeholder,
self.embedded_holder.css)
response.content = self._r... | [
"def",
"adjust_response",
"(",
"self",
",",
"response",
")",
":",
"try",
":",
"c1",
"=",
"self",
".",
"_replace",
"(",
"response",
".",
"content",
",",
"self",
".",
"header_placeholder",
",",
"self",
".",
"embedded_holder",
".",
"css",
")",
"response",
"... | Locate placeholder magic strings and replace with content | [
"Locate",
"placeholder",
"magic",
"strings",
"and",
"replace",
"with",
"content"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/middleware.py#L65-L81 |
231,840 | GibbsConsulting/django-plotly-dash | demo/demo/plotly_apps.py | callback_c | def callback_c(*args, **kwargs):
'Update the output following a change of the input selection'
#da = kwargs['dash_app']
session_state = kwargs['session_state']
calls_so_far = session_state.get('calls_so_far', 0)
session_state['calls_so_far'] = calls_so_far + 1
user_counts = session_state.get(... | python | def callback_c(*args, **kwargs):
'Update the output following a change of the input selection'
#da = kwargs['dash_app']
session_state = kwargs['session_state']
calls_so_far = session_state.get('calls_so_far', 0)
session_state['calls_so_far'] = calls_so_far + 1
user_counts = session_state.get(... | [
"def",
"callback_c",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"#da = kwargs['dash_app']",
"session_state",
"=",
"kwargs",
"[",
"'session_state'",
"]",
"calls_so_far",
"=",
"session_state",
".",
"get",
"(",
"'calls_so_far'",
",",
"0",
")",
"session_... | Update the output following a change of the input selection | [
"Update",
"the",
"output",
"following",
"a",
"change",
"of",
"the",
"input",
"selection"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/demo/demo/plotly_apps.py#L101-L118 |
231,841 | GibbsConsulting/django-plotly-dash | demo/demo/plotly_apps.py | callback_liveIn_button_press | def callback_liveIn_button_press(red_clicks, blue_clicks, green_clicks,
rc_timestamp, bc_timestamp, gc_timestamp, **kwargs): # pylint: disable=unused-argument
'Input app button pressed, so do something interesting'
if not rc_timestamp:
rc_timestamp = 0
if not bc_tim... | python | def callback_liveIn_button_press(red_clicks, blue_clicks, green_clicks,
rc_timestamp, bc_timestamp, gc_timestamp, **kwargs): # pylint: disable=unused-argument
'Input app button pressed, so do something interesting'
if not rc_timestamp:
rc_timestamp = 0
if not bc_tim... | [
"def",
"callback_liveIn_button_press",
"(",
"red_clicks",
",",
"blue_clicks",
",",
"green_clicks",
",",
"rc_timestamp",
",",
"bc_timestamp",
",",
"gc_timestamp",
",",
"*",
"*",
"kwargs",
")",
":",
"# pylint: disable=unused-argument",
"if",
"not",
"rc_timestamp",
":",
... | Input app button pressed, so do something interesting | [
"Input",
"app",
"button",
"pressed",
"so",
"do",
"something",
"interesting"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/demo/demo/plotly_apps.py#L149-L188 |
231,842 | GibbsConsulting/django-plotly-dash | demo/demo/plotly_apps.py | generate_liveOut_layout | def generate_liveOut_layout():
'Generate the layout per-app, generating each tine a new uuid for the state_uid argument'
return html.Div([
dpd.Pipe(id="named_count_pipe",
value=None,
label="named_counts",
channel_name="live_button_counter"),
htm... | python | def generate_liveOut_layout():
'Generate the layout per-app, generating each tine a new uuid for the state_uid argument'
return html.Div([
dpd.Pipe(id="named_count_pipe",
value=None,
label="named_counts",
channel_name="live_button_counter"),
htm... | [
"def",
"generate_liveOut_layout",
"(",
")",
":",
"return",
"html",
".",
"Div",
"(",
"[",
"dpd",
".",
"Pipe",
"(",
"id",
"=",
"\"named_count_pipe\"",
",",
"value",
"=",
"None",
",",
"label",
"=",
"\"named_counts\"",
",",
"channel_name",
"=",
"\"live_button_co... | Generate the layout per-app, generating each tine a new uuid for the state_uid argument | [
"Generate",
"the",
"layout",
"per",
"-",
"app",
"generating",
"each",
"tine",
"a",
"new",
"uuid",
"for",
"the",
"state_uid",
"argument"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/demo/demo/plotly_apps.py#L195-L210 |
231,843 | GibbsConsulting/django-plotly-dash | demo/demo/plotly_apps.py | callback_liveOut_pipe_in | def callback_liveOut_pipe_in(named_count, state_uid, **kwargs):
'Handle something changing the value of the input pipe or the associated state uid'
cache_key = _get_cache_key(state_uid)
state = cache.get(cache_key)
# If nothing in cache, prepopulate
if not state:
state = {}
# Guard ag... | python | def callback_liveOut_pipe_in(named_count, state_uid, **kwargs):
'Handle something changing the value of the input pipe or the associated state uid'
cache_key = _get_cache_key(state_uid)
state = cache.get(cache_key)
# If nothing in cache, prepopulate
if not state:
state = {}
# Guard ag... | [
"def",
"callback_liveOut_pipe_in",
"(",
"named_count",
",",
"state_uid",
",",
"*",
"*",
"kwargs",
")",
":",
"cache_key",
"=",
"_get_cache_key",
"(",
"state_uid",
")",
"state",
"=",
"cache",
".",
"get",
"(",
"cache_key",
")",
"# If nothing in cache, prepopulate",
... | Handle something changing the value of the input pipe or the associated state uid | [
"Handle",
"something",
"changing",
"the",
"value",
"of",
"the",
"input",
"pipe",
"or",
"the",
"associated",
"state",
"uid"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/demo/demo/plotly_apps.py#L221-L266 |
231,844 | GibbsConsulting/django-plotly-dash | demo/demo/plotly_apps.py | callback_show_timeseries | def callback_show_timeseries(internal_state_string, state_uid, **kwargs):
'Build a timeseries from the internal state'
cache_key = _get_cache_key(state_uid)
state = cache.get(cache_key)
# If nothing in cache, prepopulate
if not state:
state = {}
colour_series = {}
colors = {'red'... | python | def callback_show_timeseries(internal_state_string, state_uid, **kwargs):
'Build a timeseries from the internal state'
cache_key = _get_cache_key(state_uid)
state = cache.get(cache_key)
# If nothing in cache, prepopulate
if not state:
state = {}
colour_series = {}
colors = {'red'... | [
"def",
"callback_show_timeseries",
"(",
"internal_state_string",
",",
"state_uid",
",",
"*",
"*",
"kwargs",
")",
":",
"cache_key",
"=",
"_get_cache_key",
"(",
"state_uid",
")",
"state",
"=",
"cache",
".",
"get",
"(",
"cache_key",
")",
"# If nothing in cache, prepo... | Build a timeseries from the internal state | [
"Build",
"a",
"timeseries",
"from",
"the",
"internal",
"state"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/demo/demo/plotly_apps.py#L273-L311 |
231,845 | GibbsConsulting/django-plotly-dash | demo/demo/bootstrap_app.py | session_demo_danger_callback | def session_demo_danger_callback(da_children, session_state=None, **kwargs):
'Update output based just on state'
if not session_state:
return "Session state not yet available"
return "Session state contains: " + str(session_state.get('bootstrap_demo_state', "NOTHING")) + " and the page render count... | python | def session_demo_danger_callback(da_children, session_state=None, **kwargs):
'Update output based just on state'
if not session_state:
return "Session state not yet available"
return "Session state contains: " + str(session_state.get('bootstrap_demo_state', "NOTHING")) + " and the page render count... | [
"def",
"session_demo_danger_callback",
"(",
"da_children",
",",
"session_state",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"not",
"session_state",
":",
"return",
"\"Session state not yet available\"",
"return",
"\"Session state contains: \"",
"+",
"str",
"... | Update output based just on state | [
"Update",
"output",
"based",
"just",
"on",
"state"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/demo/demo/bootstrap_app.py#L57-L62 |
231,846 | GibbsConsulting/django-plotly-dash | demo/demo/bootstrap_app.py | session_demo_alert_callback | def session_demo_alert_callback(n_clicks, session_state=None, **kwargs):
'Output text based on both app state and session state'
if session_state is None:
raise NotImplementedError("Cannot handle a missing session state")
csf = session_state.get('bootstrap_demo_state', None)
if not csf:
... | python | def session_demo_alert_callback(n_clicks, session_state=None, **kwargs):
'Output text based on both app state and session state'
if session_state is None:
raise NotImplementedError("Cannot handle a missing session state")
csf = session_state.get('bootstrap_demo_state', None)
if not csf:
... | [
"def",
"session_demo_alert_callback",
"(",
"n_clicks",
",",
"session_state",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"session_state",
"is",
"None",
":",
"raise",
"NotImplementedError",
"(",
"\"Cannot handle a missing session state\"",
")",
"csf",
"=",
... | Output text based on both app state and session state | [
"Output",
"text",
"based",
"on",
"both",
"app",
"state",
"and",
"session",
"state"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/demo/demo/bootstrap_app.py#L69-L79 |
231,847 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | add_usable_app | def add_usable_app(name, app):
'Add app to local registry by name'
name = slugify(name)
global usable_apps # pylint: disable=global-statement
usable_apps[name] = app
return name | python | def add_usable_app(name, app):
'Add app to local registry by name'
name = slugify(name)
global usable_apps # pylint: disable=global-statement
usable_apps[name] = app
return name | [
"def",
"add_usable_app",
"(",
"name",
",",
"app",
")",
":",
"name",
"=",
"slugify",
"(",
"name",
")",
"global",
"usable_apps",
"# pylint: disable=global-statement",
"usable_apps",
"[",
"name",
"]",
"=",
"app",
"return",
"name"
] | Add app to local registry by name | [
"Add",
"app",
"to",
"local",
"registry",
"by",
"name"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L49-L54 |
231,848 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | DjangoDash.get_base_pathname | def get_base_pathname(self, specific_identifier, cache_id):
'Base path name of this instance, taking into account any state or statelessness'
if not specific_identifier:
app_pathname = "%s:app-%s"% (app_name, main_view_label)
ndid = self._uid
else:
app_pathnam... | python | def get_base_pathname(self, specific_identifier, cache_id):
'Base path name of this instance, taking into account any state or statelessness'
if not specific_identifier:
app_pathname = "%s:app-%s"% (app_name, main_view_label)
ndid = self._uid
else:
app_pathnam... | [
"def",
"get_base_pathname",
"(",
"self",
",",
"specific_identifier",
",",
"cache_id",
")",
":",
"if",
"not",
"specific_identifier",
":",
"app_pathname",
"=",
"\"%s:app-%s\"",
"%",
"(",
"app_name",
",",
"main_view_label",
")",
"ndid",
"=",
"self",
".",
"_uid",
... | Base path name of this instance, taking into account any state or statelessness | [
"Base",
"path",
"name",
"of",
"this",
"instance",
"taking",
"into",
"account",
"any",
"state",
"or",
"statelessness"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L161-L179 |
231,849 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | DjangoDash.do_form_dash_instance | def do_form_dash_instance(self, replacements=None, specific_identifier=None, cache_id=None):
'Perform the act of constructing a Dash instance taking into account state'
ndid, base_pathname = self.get_base_pathname(specific_identifier, cache_id)
return self.form_dash_instance(replacements, ndid,... | python | def do_form_dash_instance(self, replacements=None, specific_identifier=None, cache_id=None):
'Perform the act of constructing a Dash instance taking into account state'
ndid, base_pathname = self.get_base_pathname(specific_identifier, cache_id)
return self.form_dash_instance(replacements, ndid,... | [
"def",
"do_form_dash_instance",
"(",
"self",
",",
"replacements",
"=",
"None",
",",
"specific_identifier",
"=",
"None",
",",
"cache_id",
"=",
"None",
")",
":",
"ndid",
",",
"base_pathname",
"=",
"self",
".",
"get_base_pathname",
"(",
"specific_identifier",
",",
... | Perform the act of constructing a Dash instance taking into account state | [
"Perform",
"the",
"act",
"of",
"constructing",
"a",
"Dash",
"instance",
"taking",
"into",
"account",
"state"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L181-L185 |
231,850 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | DjangoDash.form_dash_instance | def form_dash_instance(self, replacements=None, ndid=None, base_pathname=None):
'Construct a Dash instance taking into account state'
if ndid is None:
ndid = self._uid
rd = WrappedDash(base_pathname=base_pathname,
expanded_callbacks=self._expanded_callbacks... | python | def form_dash_instance(self, replacements=None, ndid=None, base_pathname=None):
'Construct a Dash instance taking into account state'
if ndid is None:
ndid = self._uid
rd = WrappedDash(base_pathname=base_pathname,
expanded_callbacks=self._expanded_callbacks... | [
"def",
"form_dash_instance",
"(",
"self",
",",
"replacements",
"=",
"None",
",",
"ndid",
"=",
"None",
",",
"base_pathname",
"=",
"None",
")",
":",
"if",
"ndid",
"is",
"None",
":",
"ndid",
"=",
"self",
".",
"_uid",
"rd",
"=",
"WrappedDash",
"(",
"base_p... | Construct a Dash instance taking into account state | [
"Construct",
"a",
"Dash",
"instance",
"taking",
"into",
"account",
"state"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L187-L209 |
231,851 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | DjangoDash.callback | def callback(self, output, inputs=None, state=None, events=None):
'Form a callback function by wrapping, in the same way as the underlying Dash application would'
callback_set = {'output':output,
'inputs':inputs and inputs or dict(),
'state':state and stat... | python | def callback(self, output, inputs=None, state=None, events=None):
'Form a callback function by wrapping, in the same way as the underlying Dash application would'
callback_set = {'output':output,
'inputs':inputs and inputs or dict(),
'state':state and stat... | [
"def",
"callback",
"(",
"self",
",",
"output",
",",
"inputs",
"=",
"None",
",",
"state",
"=",
"None",
",",
"events",
"=",
"None",
")",
":",
"callback_set",
"=",
"{",
"'output'",
":",
"output",
",",
"'inputs'",
":",
"inputs",
"and",
"inputs",
"or",
"d... | Form a callback function by wrapping, in the same way as the underlying Dash application would | [
"Form",
"a",
"callback",
"function",
"by",
"wrapping",
"in",
"the",
"same",
"way",
"as",
"the",
"underlying",
"Dash",
"application",
"would"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L211-L220 |
231,852 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | DjangoDash.expanded_callback | def expanded_callback(self, output, inputs=[], state=[], events=[]): # pylint: disable=dangerous-default-value
'''
Form an expanded callback.
This function registers the callback function, and sets an internal flag that mandates that all
callbacks are passed the enhanced arguments.
... | python | def expanded_callback(self, output, inputs=[], state=[], events=[]): # pylint: disable=dangerous-default-value
'''
Form an expanded callback.
This function registers the callback function, and sets an internal flag that mandates that all
callbacks are passed the enhanced arguments.
... | [
"def",
"expanded_callback",
"(",
"self",
",",
"output",
",",
"inputs",
"=",
"[",
"]",
",",
"state",
"=",
"[",
"]",
",",
"events",
"=",
"[",
"]",
")",
":",
"# pylint: disable=dangerous-default-value",
"self",
".",
"_expanded_callbacks",
"=",
"True",
"return",... | Form an expanded callback.
This function registers the callback function, and sets an internal flag that mandates that all
callbacks are passed the enhanced arguments. | [
"Form",
"an",
"expanded",
"callback",
"."
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L222-L230 |
231,853 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | WrappedDash.augment_initial_layout | def augment_initial_layout(self, base_response, initial_arguments=None):
'Add application state to initial values'
if self.use_dash_layout() and not initial_arguments and False:
return base_response.data, base_response.mimetype
# Adjust the base layout response
baseDataInByt... | python | def augment_initial_layout(self, base_response, initial_arguments=None):
'Add application state to initial values'
if self.use_dash_layout() and not initial_arguments and False:
return base_response.data, base_response.mimetype
# Adjust the base layout response
baseDataInByt... | [
"def",
"augment_initial_layout",
"(",
"self",
",",
"base_response",
",",
"initial_arguments",
"=",
"None",
")",
":",
"if",
"self",
".",
"use_dash_layout",
"(",
")",
"and",
"not",
"initial_arguments",
"and",
"False",
":",
"return",
"base_response",
".",
"data",
... | Add application state to initial values | [
"Add",
"application",
"state",
"to",
"initial",
"values"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L312-L333 |
231,854 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | WrappedDash.walk_tree_and_extract | def walk_tree_and_extract(self, data, target):
'Walk tree of properties and extract identifiers and associated values'
if isinstance(data, dict):
for key in ['children', 'props',]:
self.walk_tree_and_extract(data.get(key, None), target)
ident = data.get('id', None... | python | def walk_tree_and_extract(self, data, target):
'Walk tree of properties and extract identifiers and associated values'
if isinstance(data, dict):
for key in ['children', 'props',]:
self.walk_tree_and_extract(data.get(key, None), target)
ident = data.get('id', None... | [
"def",
"walk_tree_and_extract",
"(",
"self",
",",
"data",
",",
"target",
")",
":",
"if",
"isinstance",
"(",
"data",
",",
"dict",
")",
":",
"for",
"key",
"in",
"[",
"'children'",
",",
"'props'",
",",
"]",
":",
"self",
".",
"walk_tree_and_extract",
"(",
... | Walk tree of properties and extract identifiers and associated values | [
"Walk",
"tree",
"of",
"properties",
"and",
"extract",
"identifiers",
"and",
"associated",
"values"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L335-L350 |
231,855 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | WrappedDash.walk_tree_and_replace | def walk_tree_and_replace(self, data, overrides):
'''
Walk the tree. Rely on json decoding to insert instances of dict and list
ie we use a dna test for anatine, rather than our eyes and ears...
'''
if isinstance(data, dict):
response = {}
replacements = {... | python | def walk_tree_and_replace(self, data, overrides):
'''
Walk the tree. Rely on json decoding to insert instances of dict and list
ie we use a dna test for anatine, rather than our eyes and ears...
'''
if isinstance(data, dict):
response = {}
replacements = {... | [
"def",
"walk_tree_and_replace",
"(",
"self",
",",
"data",
",",
"overrides",
")",
":",
"if",
"isinstance",
"(",
"data",
",",
"dict",
")",
":",
"response",
"=",
"{",
"}",
"replacements",
"=",
"{",
"}",
"# look for id entry",
"thisID",
"=",
"data",
".",
"ge... | Walk the tree. Rely on json decoding to insert instances of dict and list
ie we use a dna test for anatine, rather than our eyes and ears... | [
"Walk",
"the",
"tree",
".",
"Rely",
"on",
"json",
"decoding",
"to",
"insert",
"instances",
"of",
"dict",
"and",
"list",
"ie",
"we",
"use",
"a",
"dna",
"test",
"for",
"anatine",
"rather",
"than",
"our",
"eyes",
"and",
"ears",
"..."
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L352-L376 |
231,856 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | WrappedDash.locate_endpoint_function | def locate_endpoint_function(self, name=None):
'Locate endpoint function given name of view'
if name is not None:
ep = "%s_%s" %(self._base_pathname,
name)
else:
ep = self._base_pathname
return self._notflask.endpoints[ep]['view_func'] | python | def locate_endpoint_function(self, name=None):
'Locate endpoint function given name of view'
if name is not None:
ep = "%s_%s" %(self._base_pathname,
name)
else:
ep = self._base_pathname
return self._notflask.endpoints[ep]['view_func'] | [
"def",
"locate_endpoint_function",
"(",
"self",
",",
"name",
"=",
"None",
")",
":",
"if",
"name",
"is",
"not",
"None",
":",
"ep",
"=",
"\"%s_%s\"",
"%",
"(",
"self",
".",
"_base_pathname",
",",
"name",
")",
"else",
":",
"ep",
"=",
"self",
".",
"_base... | Locate endpoint function given name of view | [
"Locate",
"endpoint",
"function",
"given",
"name",
"of",
"view"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L396-L403 |
231,857 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | WrappedDash.layout | def layout(self, value):
'Overloaded layout function to fix component names as needed'
if self._adjust_id:
self._fix_component_id(value)
return Dash.layout.fset(self, value) | python | def layout(self, value):
'Overloaded layout function to fix component names as needed'
if self._adjust_id:
self._fix_component_id(value)
return Dash.layout.fset(self, value) | [
"def",
"layout",
"(",
"self",
",",
"value",
")",
":",
"if",
"self",
".",
"_adjust_id",
":",
"self",
".",
"_fix_component_id",
"(",
"value",
")",
"return",
"Dash",
".",
"layout",
".",
"fset",
"(",
"self",
",",
"value",
")"
] | Overloaded layout function to fix component names as needed | [
"Overloaded",
"layout",
"function",
"to",
"fix",
"component",
"names",
"as",
"needed"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L407-L412 |
231,858 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | WrappedDash._fix_component_id | def _fix_component_id(self, component):
'Fix name of component ad all of its children'
theID = getattr(component, "id", None)
if theID is not None:
setattr(component, "id", self._fix_id(theID))
try:
for c in component.children:
self._fix_component... | python | def _fix_component_id(self, component):
'Fix name of component ad all of its children'
theID = getattr(component, "id", None)
if theID is not None:
setattr(component, "id", self._fix_id(theID))
try:
for c in component.children:
self._fix_component... | [
"def",
"_fix_component_id",
"(",
"self",
",",
"component",
")",
":",
"theID",
"=",
"getattr",
"(",
"component",
",",
"\"id\"",
",",
"None",
")",
"if",
"theID",
"is",
"not",
"None",
":",
"setattr",
"(",
"component",
",",
"\"id\"",
",",
"self",
".",
"_fi... | Fix name of component ad all of its children | [
"Fix",
"name",
"of",
"component",
"ad",
"all",
"of",
"its",
"children"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L414-L424 |
231,859 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | WrappedDash._fix_callback_item | def _fix_callback_item(self, item):
'Update component identifier'
item.component_id = self._fix_id(item.component_id)
return item | python | def _fix_callback_item(self, item):
'Update component identifier'
item.component_id = self._fix_id(item.component_id)
return item | [
"def",
"_fix_callback_item",
"(",
"self",
",",
"item",
")",
":",
"item",
".",
"component_id",
"=",
"self",
".",
"_fix_id",
"(",
"item",
".",
"component_id",
")",
"return",
"item"
] | Update component identifier | [
"Update",
"component",
"identifier"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L433-L436 |
231,860 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | WrappedDash.callback | def callback(self, output, inputs=[], state=[], events=[]): # pylint: disable=dangerous-default-value
'Invoke callback, adjusting variable names as needed'
if isinstance(output, (list, tuple)):
fixed_outputs = [self._fix_callback_item(x) for x in output]
# Temporary check; can b... | python | def callback(self, output, inputs=[], state=[], events=[]): # pylint: disable=dangerous-default-value
'Invoke callback, adjusting variable names as needed'
if isinstance(output, (list, tuple)):
fixed_outputs = [self._fix_callback_item(x) for x in output]
# Temporary check; can b... | [
"def",
"callback",
"(",
"self",
",",
"output",
",",
"inputs",
"=",
"[",
"]",
",",
"state",
"=",
"[",
"]",
",",
"events",
"=",
"[",
"]",
")",
":",
"# pylint: disable=dangerous-default-value",
"if",
"isinstance",
"(",
"output",
",",
"(",
"list",
",",
"tu... | Invoke callback, adjusting variable names as needed | [
"Invoke",
"callback",
"adjusting",
"variable",
"names",
"as",
"needed"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L438-L450 |
231,861 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | WrappedDash.dispatch | def dispatch(self):
'Perform dispatch, using request embedded within flask global state'
import flask
body = flask.request.get_json()
return self. dispatch_with_args(body, argMap=dict()) | python | def dispatch(self):
'Perform dispatch, using request embedded within flask global state'
import flask
body = flask.request.get_json()
return self. dispatch_with_args(body, argMap=dict()) | [
"def",
"dispatch",
"(",
"self",
")",
":",
"import",
"flask",
"body",
"=",
"flask",
".",
"request",
".",
"get_json",
"(",
")",
"return",
"self",
".",
"dispatch_with_args",
"(",
"body",
",",
"argMap",
"=",
"dict",
"(",
")",
")"
] | Perform dispatch, using request embedded within flask global state | [
"Perform",
"dispatch",
"using",
"request",
"embedded",
"within",
"flask",
"global",
"state"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L452-L456 |
231,862 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | WrappedDash.dispatch_with_args | def dispatch_with_args(self, body, argMap):
'Perform callback dispatching, with enhanced arguments and recording of response'
inputs = body.get('inputs', [])
state = body.get('state', [])
output = body['output']
try:
output_id = output['id']
output_proper... | python | def dispatch_with_args(self, body, argMap):
'Perform callback dispatching, with enhanced arguments and recording of response'
inputs = body.get('inputs', [])
state = body.get('state', [])
output = body['output']
try:
output_id = output['id']
output_proper... | [
"def",
"dispatch_with_args",
"(",
"self",
",",
"body",
",",
"argMap",
")",
":",
"inputs",
"=",
"body",
".",
"get",
"(",
"'inputs'",
",",
"[",
"]",
")",
"state",
"=",
"body",
".",
"get",
"(",
"'state'",
",",
"[",
"]",
")",
"output",
"=",
"body",
"... | Perform callback dispatching, with enhanced arguments and recording of response | [
"Perform",
"callback",
"dispatching",
"with",
"enhanced",
"arguments",
"and",
"recording",
"of",
"response"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L459-L506 |
231,863 | GibbsConsulting/django-plotly-dash | django_plotly_dash/dash_wrapper.py | WrappedDash.extra_html_properties | def extra_html_properties(self, prefix=None, postfix=None, template_type=None):
'''
Return extra html properties to allow individual apps to be styled separately.
The content returned from this function is injected unescaped into templates.
'''
prefix = prefix if prefix else "d... | python | def extra_html_properties(self, prefix=None, postfix=None, template_type=None):
'''
Return extra html properties to allow individual apps to be styled separately.
The content returned from this function is injected unescaped into templates.
'''
prefix = prefix if prefix else "d... | [
"def",
"extra_html_properties",
"(",
"self",
",",
"prefix",
"=",
"None",
",",
"postfix",
"=",
"None",
",",
"template_type",
"=",
"None",
")",
":",
"prefix",
"=",
"prefix",
"if",
"prefix",
"else",
"\"django-plotly-dash\"",
"post_part",
"=",
"\"-%s\"",
"%",
"p... | Return extra html properties to allow individual apps to be styled separately.
The content returned from this function is injected unescaped into templates. | [
"Return",
"extra",
"html",
"properties",
"to",
"allow",
"individual",
"apps",
"to",
"be",
"styled",
"separately",
"."
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/dash_wrapper.py#L513-L531 |
231,864 | GibbsConsulting/django-plotly-dash | django_plotly_dash/templatetags/plotly_dash.py | plotly_direct | def plotly_direct(context, name=None, slug=None, da=None):
'Direct insertion of a Dash app'
da, app = _locate_daapp(name, slug, da)
view_func = app.locate_endpoint_function()
# Load embedded holder inserted by middleware
eh = context.request.dpd_content_handler.embedded_holder
app.set_embedde... | python | def plotly_direct(context, name=None, slug=None, da=None):
'Direct insertion of a Dash app'
da, app = _locate_daapp(name, slug, da)
view_func = app.locate_endpoint_function()
# Load embedded holder inserted by middleware
eh = context.request.dpd_content_handler.embedded_holder
app.set_embedde... | [
"def",
"plotly_direct",
"(",
"context",
",",
"name",
"=",
"None",
",",
"slug",
"=",
"None",
",",
"da",
"=",
"None",
")",
":",
"da",
",",
"app",
"=",
"_locate_daapp",
"(",
"name",
",",
"slug",
",",
"da",
")",
"view_func",
"=",
"app",
".",
"locate_en... | Direct insertion of a Dash app | [
"Direct",
"insertion",
"of",
"a",
"Dash",
"app"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/templatetags/plotly_dash.py#L91-L106 |
231,865 | GibbsConsulting/django-plotly-dash | django_plotly_dash/templatetags/plotly_dash.py | plotly_app_identifier | def plotly_app_identifier(name=None, slug=None, da=None, postfix=None):
'Return a slug-friendly identifier'
da, app = _locate_daapp(name, slug, da)
slugified_id = app.slugified_id()
if postfix:
return "%s-%s" %(slugified_id, postfix)
return slugified_id | python | def plotly_app_identifier(name=None, slug=None, da=None, postfix=None):
'Return a slug-friendly identifier'
da, app = _locate_daapp(name, slug, da)
slugified_id = app.slugified_id()
if postfix:
return "%s-%s" %(slugified_id, postfix)
return slugified_id | [
"def",
"plotly_app_identifier",
"(",
"name",
"=",
"None",
",",
"slug",
"=",
"None",
",",
"da",
"=",
"None",
",",
"postfix",
"=",
"None",
")",
":",
"da",
",",
"app",
"=",
"_locate_daapp",
"(",
"name",
",",
"slug",
",",
"da",
")",
"slugified_id",
"=",
... | Return a slug-friendly identifier | [
"Return",
"a",
"slug",
"-",
"friendly",
"identifier"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/templatetags/plotly_dash.py#L115-L124 |
231,866 | GibbsConsulting/django-plotly-dash | django_plotly_dash/templatetags/plotly_dash.py | plotly_class | def plotly_class(name=None, slug=None, da=None, prefix=None, postfix=None, template_type=None):
'Return a string of space-separated class names'
da, app = _locate_daapp(name, slug, da)
return app.extra_html_properties(prefix=prefix,
postfix=postfix,
... | python | def plotly_class(name=None, slug=None, da=None, prefix=None, postfix=None, template_type=None):
'Return a string of space-separated class names'
da, app = _locate_daapp(name, slug, da)
return app.extra_html_properties(prefix=prefix,
postfix=postfix,
... | [
"def",
"plotly_class",
"(",
"name",
"=",
"None",
",",
"slug",
"=",
"None",
",",
"da",
"=",
"None",
",",
"prefix",
"=",
"None",
",",
"postfix",
"=",
"None",
",",
"template_type",
"=",
"None",
")",
":",
"da",
",",
"app",
"=",
"_locate_daapp",
"(",
"n... | Return a string of space-separated class names | [
"Return",
"a",
"string",
"of",
"space",
"-",
"separated",
"class",
"names"
] | 773ed081fc2ea3cc7607590322a14686a7a79bc5 | https://github.com/GibbsConsulting/django-plotly-dash/blob/773ed081fc2ea3cc7607590322a14686a7a79bc5/django_plotly_dash/templatetags/plotly_dash.py#L127-L134 |
231,867 | atztogo/spglib | database/make_Wyckoff_db.py | parse_wyckoff_csv | def parse_wyckoff_csv(wyckoff_file):
"""Parse Wyckoff.csv
There are 530 data sets. For one example:
9:C 1 2 1:::::::
::4:c:1:(x,y,z):(-x,y,-z)::
::2:b:2:(0,y,1/2):::
::2:a:2:(0,y,0):::
"""
rowdata = []
points = []
hP_nums = [433, 436, 444, 450, 452, 458, 460]
for i, line ... | python | def parse_wyckoff_csv(wyckoff_file):
"""Parse Wyckoff.csv
There are 530 data sets. For one example:
9:C 1 2 1:::::::
::4:c:1:(x,y,z):(-x,y,-z)::
::2:b:2:(0,y,1/2):::
::2:a:2:(0,y,0):::
"""
rowdata = []
points = []
hP_nums = [433, 436, 444, 450, 452, 458, 460]
for i, line ... | [
"def",
"parse_wyckoff_csv",
"(",
"wyckoff_file",
")",
":",
"rowdata",
"=",
"[",
"]",
"points",
"=",
"[",
"]",
"hP_nums",
"=",
"[",
"433",
",",
"436",
",",
"444",
",",
"450",
",",
"452",
",",
"458",
",",
"460",
"]",
"for",
"i",
",",
"line",
"in",
... | Parse Wyckoff.csv
There are 530 data sets. For one example:
9:C 1 2 1:::::::
::4:c:1:(x,y,z):(-x,y,-z)::
::2:b:2:(0,y,1/2):::
::2:a:2:(0,y,0)::: | [
"Parse",
"Wyckoff",
".",
"csv"
] | e10a8f24e6e3bc1adfd8c511073442c0e7fc67b6 | https://github.com/atztogo/spglib/blob/e10a8f24e6e3bc1adfd8c511073442c0e7fc67b6/database/make_Wyckoff_db.py#L179-L251 |
231,868 | atztogo/spglib | database/make_Wyckoff_db.py | get_site_symmetries | def get_site_symmetries(wyckoff):
"""List up site symmetries
The data structure is as follows:
wyckoff[0]['wyckoff'][0]['site_symmetry']
Note
----
Maximum length of string is 6.
"""
ssyms = []
for w in wyckoff:
ssyms += ["\"%-6s\"" % w_s['site_symmetry'] for w_s in w... | python | def get_site_symmetries(wyckoff):
"""List up site symmetries
The data structure is as follows:
wyckoff[0]['wyckoff'][0]['site_symmetry']
Note
----
Maximum length of string is 6.
"""
ssyms = []
for w in wyckoff:
ssyms += ["\"%-6s\"" % w_s['site_symmetry'] for w_s in w... | [
"def",
"get_site_symmetries",
"(",
"wyckoff",
")",
":",
"ssyms",
"=",
"[",
"]",
"for",
"w",
"in",
"wyckoff",
":",
"ssyms",
"+=",
"[",
"\"\\\"%-6s\\\"\"",
"%",
"w_s",
"[",
"'site_symmetry'",
"]",
"for",
"w_s",
"in",
"w",
"[",
"'wyckoff'",
"]",
"]",
"dam... | List up site symmetries
The data structure is as follows:
wyckoff[0]['wyckoff'][0]['site_symmetry']
Note
----
Maximum length of string is 6. | [
"List",
"up",
"site",
"symmetries"
] | e10a8f24e6e3bc1adfd8c511073442c0e7fc67b6 | https://github.com/atztogo/spglib/blob/e10a8f24e6e3bc1adfd8c511073442c0e7fc67b6/database/make_Wyckoff_db.py#L280-L297 |
231,869 | tortoise/tortoise-orm | tortoise/contrib/pylint/__init__.py | transform_model | def transform_model(cls) -> None:
"""
Anything that uses the ModelMeta needs _meta and id.
Also keep track of relationships and make them in the related model class.
"""
if cls.name != "Model":
appname = "models"
for mcls in cls.get_children():
if isinstance(mcls, ClassDe... | python | def transform_model(cls) -> None:
"""
Anything that uses the ModelMeta needs _meta and id.
Also keep track of relationships and make them in the related model class.
"""
if cls.name != "Model":
appname = "models"
for mcls in cls.get_children():
if isinstance(mcls, ClassDe... | [
"def",
"transform_model",
"(",
"cls",
")",
"->",
"None",
":",
"if",
"cls",
".",
"name",
"!=",
"\"Model\"",
":",
"appname",
"=",
"\"models\"",
"for",
"mcls",
"in",
"cls",
".",
"get_children",
"(",
")",
":",
"if",
"isinstance",
"(",
"mcls",
",",
"ClassDe... | Anything that uses the ModelMeta needs _meta and id.
Also keep track of relationships and make them in the related model class. | [
"Anything",
"that",
"uses",
"the",
"ModelMeta",
"needs",
"_meta",
"and",
"id",
".",
"Also",
"keep",
"track",
"of",
"relationships",
"and",
"make",
"them",
"in",
"the",
"related",
"model",
"class",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/contrib/pylint/__init__.py#L32-L95 |
231,870 | tortoise/tortoise-orm | tortoise/contrib/pylint/__init__.py | apply_type_shim | def apply_type_shim(cls, _context=None) -> Iterator:
"""
Morphs model fields to representative type
"""
if cls.name in ["IntField", "SmallIntField"]:
base_nodes = scoped_nodes.builtin_lookup("int")
elif cls.name in ["CharField", "TextField"]:
base_nodes = scoped_nodes.builtin_lookup(... | python | def apply_type_shim(cls, _context=None) -> Iterator:
"""
Morphs model fields to representative type
"""
if cls.name in ["IntField", "SmallIntField"]:
base_nodes = scoped_nodes.builtin_lookup("int")
elif cls.name in ["CharField", "TextField"]:
base_nodes = scoped_nodes.builtin_lookup(... | [
"def",
"apply_type_shim",
"(",
"cls",
",",
"_context",
"=",
"None",
")",
"->",
"Iterator",
":",
"if",
"cls",
".",
"name",
"in",
"[",
"\"IntField\"",
",",
"\"SmallIntField\"",
"]",
":",
"base_nodes",
"=",
"scoped_nodes",
".",
"builtin_lookup",
"(",
"\"int\"",... | Morphs model fields to representative type | [
"Morphs",
"model",
"fields",
"to",
"representative",
"type"
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/contrib/pylint/__init__.py#L105-L132 |
231,871 | tortoise/tortoise-orm | tortoise/filters.py | list_encoder | def list_encoder(values, instance, field: Field):
"""Encodes an iterable of a given field into a database-compatible format."""
return [field.to_db_value(element, instance) for element in values] | python | def list_encoder(values, instance, field: Field):
"""Encodes an iterable of a given field into a database-compatible format."""
return [field.to_db_value(element, instance) for element in values] | [
"def",
"list_encoder",
"(",
"values",
",",
"instance",
",",
"field",
":",
"Field",
")",
":",
"return",
"[",
"field",
".",
"to_db_value",
"(",
"element",
",",
"instance",
")",
"for",
"element",
"in",
"values",
"]"
] | Encodes an iterable of a given field into a database-compatible format. | [
"Encodes",
"an",
"iterable",
"of",
"a",
"given",
"field",
"into",
"a",
"database",
"-",
"compatible",
"format",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/filters.py#L11-L13 |
231,872 | tortoise/tortoise-orm | tortoise/fields.py | ManyToManyRelationManager.add | async def add(self, *instances, using_db=None) -> None:
"""
Adds one or more of ``instances`` to the relation.
If it is already added, it will be silently ignored.
"""
if not instances:
return
if self.instance.id is None:
raise OperationalError(
... | python | async def add(self, *instances, using_db=None) -> None:
"""
Adds one or more of ``instances`` to the relation.
If it is already added, it will be silently ignored.
"""
if not instances:
return
if self.instance.id is None:
raise OperationalError(
... | [
"async",
"def",
"add",
"(",
"self",
",",
"*",
"instances",
",",
"using_db",
"=",
"None",
")",
"->",
"None",
":",
"if",
"not",
"instances",
":",
"return",
"if",
"self",
".",
"instance",
".",
"id",
"is",
"None",
":",
"raise",
"OperationalError",
"(",
"... | Adds one or more of ``instances`` to the relation.
If it is already added, it will be silently ignored. | [
"Adds",
"one",
"or",
"more",
"of",
"instances",
"to",
"the",
"relation",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/fields.py#L539-L589 |
231,873 | tortoise/tortoise-orm | tortoise/fields.py | ManyToManyRelationManager.clear | async def clear(self, using_db=None) -> None:
"""
Clears ALL relations.
"""
db = using_db if using_db else self.model._meta.db
through_table = Table(self.field.through)
query = (
db.query_class.from_(through_table)
.where(getattr(through_table, sel... | python | async def clear(self, using_db=None) -> None:
"""
Clears ALL relations.
"""
db = using_db if using_db else self.model._meta.db
through_table = Table(self.field.through)
query = (
db.query_class.from_(through_table)
.where(getattr(through_table, sel... | [
"async",
"def",
"clear",
"(",
"self",
",",
"using_db",
"=",
"None",
")",
"->",
"None",
":",
"db",
"=",
"using_db",
"if",
"using_db",
"else",
"self",
".",
"model",
".",
"_meta",
".",
"db",
"through_table",
"=",
"Table",
"(",
"self",
".",
"field",
".",... | Clears ALL relations. | [
"Clears",
"ALL",
"relations",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/fields.py#L591-L602 |
231,874 | tortoise/tortoise-orm | tortoise/fields.py | ManyToManyRelationManager.remove | async def remove(self, *instances, using_db=None) -> None:
"""
Removes one or more of ``instances`` from the relation.
"""
db = using_db if using_db else self.model._meta.db
if not instances:
raise OperationalError("remove() called on no instances")
through_ta... | python | async def remove(self, *instances, using_db=None) -> None:
"""
Removes one or more of ``instances`` from the relation.
"""
db = using_db if using_db else self.model._meta.db
if not instances:
raise OperationalError("remove() called on no instances")
through_ta... | [
"async",
"def",
"remove",
"(",
"self",
",",
"*",
"instances",
",",
"using_db",
"=",
"None",
")",
"->",
"None",
":",
"db",
"=",
"using_db",
"if",
"using_db",
"else",
"self",
".",
"model",
".",
"_meta",
".",
"db",
"if",
"not",
"instances",
":",
"raise"... | Removes one or more of ``instances`` from the relation. | [
"Removes",
"one",
"or",
"more",
"of",
"instances",
"from",
"the",
"relation",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/fields.py#L604-L622 |
231,875 | tortoise/tortoise-orm | tortoise/contrib/quart/__init__.py | register_tortoise | def register_tortoise(
app: Quart,
config: Optional[dict] = None,
config_file: Optional[str] = None,
db_url: Optional[str] = None,
modules: Optional[Dict[str, List[str]]] = None,
generate_schemas: bool = False,
) -> None:
"""
Registers ``before_serving`` and ``after_serving`` hooks to se... | python | def register_tortoise(
app: Quart,
config: Optional[dict] = None,
config_file: Optional[str] = None,
db_url: Optional[str] = None,
modules: Optional[Dict[str, List[str]]] = None,
generate_schemas: bool = False,
) -> None:
"""
Registers ``before_serving`` and ``after_serving`` hooks to se... | [
"def",
"register_tortoise",
"(",
"app",
":",
"Quart",
",",
"config",
":",
"Optional",
"[",
"dict",
"]",
"=",
"None",
",",
"config_file",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",
",",
"db_url",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",
",",... | Registers ``before_serving`` and ``after_serving`` hooks to set-up and tear-down Tortoise-ORM
inside a Quart service.
It also registers a CLI command ``generate_schemas`` that will generate the schemas.
You can configure using only one of ``config``, ``config_file``
and ``(db_url, modules)``.
Para... | [
"Registers",
"before_serving",
"and",
"after_serving",
"hooks",
"to",
"set",
"-",
"up",
"and",
"tear",
"-",
"down",
"Tortoise",
"-",
"ORM",
"inside",
"a",
"Quart",
"service",
".",
"It",
"also",
"registers",
"a",
"CLI",
"command",
"generate_schemas",
"that",
... | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/contrib/quart/__init__.py#L13-L105 |
231,876 | tortoise/tortoise-orm | tortoise/__init__.py | run_async | def run_async(coro: Coroutine) -> None:
"""
Simple async runner that cleans up DB connections on exit.
This is meant for simple scripts.
Usage::
from tortoise import Tortoise, run_async
async def do_stuff():
await Tortoise.init(
db_url='sqlite://db.sqlite3'... | python | def run_async(coro: Coroutine) -> None:
"""
Simple async runner that cleans up DB connections on exit.
This is meant for simple scripts.
Usage::
from tortoise import Tortoise, run_async
async def do_stuff():
await Tortoise.init(
db_url='sqlite://db.sqlite3'... | [
"def",
"run_async",
"(",
"coro",
":",
"Coroutine",
")",
"->",
"None",
":",
"loop",
"=",
"asyncio",
".",
"get_event_loop",
"(",
")",
"try",
":",
"loop",
".",
"run_until_complete",
"(",
"coro",
")",
"finally",
":",
"loop",
".",
"run_until_complete",
"(",
"... | Simple async runner that cleans up DB connections on exit.
This is meant for simple scripts.
Usage::
from tortoise import Tortoise, run_async
async def do_stuff():
await Tortoise.init(
db_url='sqlite://db.sqlite3',
models={'models': ['app.models']}
... | [
"Simple",
"async",
"runner",
"that",
"cleans",
"up",
"DB",
"connections",
"on",
"exit",
".",
"This",
"is",
"meant",
"for",
"simple",
"scripts",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/__init__.py#L381-L404 |
231,877 | tortoise/tortoise-orm | tortoise/__init__.py | Tortoise.init | async def init(
cls,
config: Optional[dict] = None,
config_file: Optional[str] = None,
_create_db: bool = False,
db_url: Optional[str] = None,
modules: Optional[Dict[str, List[str]]] = None,
) -> None:
"""
Sets up Tortoise-ORM.
You can configu... | python | async def init(
cls,
config: Optional[dict] = None,
config_file: Optional[str] = None,
_create_db: bool = False,
db_url: Optional[str] = None,
modules: Optional[Dict[str, List[str]]] = None,
) -> None:
"""
Sets up Tortoise-ORM.
You can configu... | [
"async",
"def",
"init",
"(",
"cls",
",",
"config",
":",
"Optional",
"[",
"dict",
"]",
"=",
"None",
",",
"config_file",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",
",",
"_create_db",
":",
"bool",
"=",
"False",
",",
"db_url",
":",
"Optional",
"[",
... | Sets up Tortoise-ORM.
You can configure using only one of ``config``, ``config_file``
and ``(db_url, modules)``.
Parameters
----------
config:
Dict containing config:
Example
-------
.. code-block:: python3
{
... | [
"Sets",
"up",
"Tortoise",
"-",
"ORM",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/__init__.py#L231-L332 |
231,878 | tortoise/tortoise-orm | tortoise/transactions.py | in_transaction | def in_transaction(connection_name: Optional[str] = None) -> BaseTransactionWrapper:
"""
Transaction context manager.
You can run your code inside ``async with in_transaction():`` statement to run it
into one transaction. If error occurs transaction will rollback.
:param connection_name: name of c... | python | def in_transaction(connection_name: Optional[str] = None) -> BaseTransactionWrapper:
"""
Transaction context manager.
You can run your code inside ``async with in_transaction():`` statement to run it
into one transaction. If error occurs transaction will rollback.
:param connection_name: name of c... | [
"def",
"in_transaction",
"(",
"connection_name",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",
")",
"->",
"BaseTransactionWrapper",
":",
"connection",
"=",
"_get_connection",
"(",
"connection_name",
")",
"return",
"connection",
".",
"_in_transaction",
"(",
")"
] | Transaction context manager.
You can run your code inside ``async with in_transaction():`` statement to run it
into one transaction. If error occurs transaction will rollback.
:param connection_name: name of connection to run with, optional if you have only
one db connection | [
"Transaction",
"context",
"manager",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/transactions.py#L25-L36 |
231,879 | tortoise/tortoise-orm | tortoise/transactions.py | atomic | def atomic(connection_name: Optional[str] = None) -> Callable:
"""
Transaction decorator.
You can wrap your function with this decorator to run it into one transaction.
If error occurs transaction will rollback.
:param connection_name: name of connection to run with, optional if you have only
... | python | def atomic(connection_name: Optional[str] = None) -> Callable:
"""
Transaction decorator.
You can wrap your function with this decorator to run it into one transaction.
If error occurs transaction will rollback.
:param connection_name: name of connection to run with, optional if you have only
... | [
"def",
"atomic",
"(",
"connection_name",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",
")",
"->",
"Callable",
":",
"def",
"wrapper",
"(",
"func",
")",
":",
"@",
"wraps",
"(",
"func",
")",
"async",
"def",
"wrapped",
"(",
"*",
"args",
",",
"*",
"*",... | Transaction decorator.
You can wrap your function with this decorator to run it into one transaction.
If error occurs transaction will rollback.
:param connection_name: name of connection to run with, optional if you have only
one db connection | [
"Transaction",
"decorator",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/transactions.py#L39-L59 |
231,880 | tortoise/tortoise-orm | tortoise/transactions.py | start_transaction | async def start_transaction(connection_name: Optional[str] = None) -> BaseTransactionWrapper:
"""
Function to manually control your transaction.
Returns transaction object with ``.rollback()`` and ``.commit()`` methods.
All db calls in same coroutine context will run into transaction
before ending ... | python | async def start_transaction(connection_name: Optional[str] = None) -> BaseTransactionWrapper:
"""
Function to manually control your transaction.
Returns transaction object with ``.rollback()`` and ``.commit()`` methods.
All db calls in same coroutine context will run into transaction
before ending ... | [
"async",
"def",
"start_transaction",
"(",
"connection_name",
":",
"Optional",
"[",
"str",
"]",
"=",
"None",
")",
"->",
"BaseTransactionWrapper",
":",
"connection",
"=",
"_get_connection",
"(",
"connection_name",
")",
"transaction",
"=",
"connection",
".",
"_in_tra... | Function to manually control your transaction.
Returns transaction object with ``.rollback()`` and ``.commit()`` methods.
All db calls in same coroutine context will run into transaction
before ending transaction with above methods.
:param connection_name: name of connection to run with, optional if y... | [
"Function",
"to",
"manually",
"control",
"your",
"transaction",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/transactions.py#L62-L76 |
231,881 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.limit | def limit(self, limit: int) -> "QuerySet":
"""
Limits QuerySet to given length.
"""
queryset = self._clone()
queryset._limit = limit
return queryset | python | def limit(self, limit: int) -> "QuerySet":
"""
Limits QuerySet to given length.
"""
queryset = self._clone()
queryset._limit = limit
return queryset | [
"def",
"limit",
"(",
"self",
",",
"limit",
":",
"int",
")",
"->",
"\"QuerySet\"",
":",
"queryset",
"=",
"self",
".",
"_clone",
"(",
")",
"queryset",
".",
"_limit",
"=",
"limit",
"return",
"queryset"
] | Limits QuerySet to given length. | [
"Limits",
"QuerySet",
"to",
"given",
"length",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L218-L224 |
231,882 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.offset | def offset(self, offset: int) -> "QuerySet":
"""
Query offset for QuerySet.
"""
queryset = self._clone()
queryset._offset = offset
if self.capabilities.requires_limit and queryset._limit is None:
queryset._limit = 1000000
return queryset | python | def offset(self, offset: int) -> "QuerySet":
"""
Query offset for QuerySet.
"""
queryset = self._clone()
queryset._offset = offset
if self.capabilities.requires_limit and queryset._limit is None:
queryset._limit = 1000000
return queryset | [
"def",
"offset",
"(",
"self",
",",
"offset",
":",
"int",
")",
"->",
"\"QuerySet\"",
":",
"queryset",
"=",
"self",
".",
"_clone",
"(",
")",
"queryset",
".",
"_offset",
"=",
"offset",
"if",
"self",
".",
"capabilities",
".",
"requires_limit",
"and",
"querys... | Query offset for QuerySet. | [
"Query",
"offset",
"for",
"QuerySet",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L226-L234 |
231,883 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.annotate | def annotate(self, **kwargs) -> "QuerySet":
"""
Annotate result with aggregation result.
"""
queryset = self._clone()
for key, aggregation in kwargs.items():
if not isinstance(aggregation, Aggregate):
raise TypeError("value is expected to be Aggregate ... | python | def annotate(self, **kwargs) -> "QuerySet":
"""
Annotate result with aggregation result.
"""
queryset = self._clone()
for key, aggregation in kwargs.items():
if not isinstance(aggregation, Aggregate):
raise TypeError("value is expected to be Aggregate ... | [
"def",
"annotate",
"(",
"self",
",",
"*",
"*",
"kwargs",
")",
"->",
"\"QuerySet\"",
":",
"queryset",
"=",
"self",
".",
"_clone",
"(",
")",
"for",
"key",
",",
"aggregation",
"in",
"kwargs",
".",
"items",
"(",
")",
":",
"if",
"not",
"isinstance",
"(",
... | Annotate result with aggregation result. | [
"Annotate",
"result",
"with",
"aggregation",
"result",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L244-L256 |
231,884 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.values_list | def values_list(
self, *fields_: str, flat: bool = False
) -> "ValuesListQuery": # pylint: disable=W0621
"""
Make QuerySet returns list of tuples for given args instead of objects.
If ```flat=True`` and only one arg is passed can return flat list.
"""
return ValuesLi... | python | def values_list(
self, *fields_: str, flat: bool = False
) -> "ValuesListQuery": # pylint: disable=W0621
"""
Make QuerySet returns list of tuples for given args instead of objects.
If ```flat=True`` and only one arg is passed can return flat list.
"""
return ValuesLi... | [
"def",
"values_list",
"(",
"self",
",",
"*",
"fields_",
":",
"str",
",",
"flat",
":",
"bool",
"=",
"False",
")",
"->",
"\"ValuesListQuery\"",
":",
"# pylint: disable=W0621",
"return",
"ValuesListQuery",
"(",
"db",
"=",
"self",
".",
"_db",
",",
"model",
"="... | Make QuerySet returns list of tuples for given args instead of objects.
If ```flat=True`` and only one arg is passed can return flat list. | [
"Make",
"QuerySet",
"returns",
"list",
"of",
"tuples",
"for",
"given",
"args",
"instead",
"of",
"objects",
".",
"If",
"flat",
"=",
"True",
"and",
"only",
"one",
"arg",
"is",
"passed",
"can",
"return",
"flat",
"list",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L258-L277 |
231,885 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.values | def values(self, *args: str, **kwargs: str) -> "ValuesQuery":
"""
Make QuerySet return dicts instead of objects.
"""
fields_for_select = {} # type: Dict[str, str]
for field in args:
if field in fields_for_select:
raise FieldError("Duplicate key {}".fo... | python | def values(self, *args: str, **kwargs: str) -> "ValuesQuery":
"""
Make QuerySet return dicts instead of objects.
"""
fields_for_select = {} # type: Dict[str, str]
for field in args:
if field in fields_for_select:
raise FieldError("Duplicate key {}".fo... | [
"def",
"values",
"(",
"self",
",",
"*",
"args",
":",
"str",
",",
"*",
"*",
"kwargs",
":",
"str",
")",
"->",
"\"ValuesQuery\"",
":",
"fields_for_select",
"=",
"{",
"}",
"# type: Dict[str, str]",
"for",
"field",
"in",
"args",
":",
"if",
"field",
"in",
"f... | Make QuerySet return dicts instead of objects. | [
"Make",
"QuerySet",
"return",
"dicts",
"instead",
"of",
"objects",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L279-L305 |
231,886 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.delete | def delete(self) -> "DeleteQuery":
"""
Delete all objects in QuerySet.
"""
return DeleteQuery(
db=self._db,
model=self.model,
q_objects=self._q_objects,
annotations=self._annotations,
custom_filters=self._custom_filters,
... | python | def delete(self) -> "DeleteQuery":
"""
Delete all objects in QuerySet.
"""
return DeleteQuery(
db=self._db,
model=self.model,
q_objects=self._q_objects,
annotations=self._annotations,
custom_filters=self._custom_filters,
... | [
"def",
"delete",
"(",
"self",
")",
"->",
"\"DeleteQuery\"",
":",
"return",
"DeleteQuery",
"(",
"db",
"=",
"self",
".",
"_db",
",",
"model",
"=",
"self",
".",
"model",
",",
"q_objects",
"=",
"self",
".",
"_q_objects",
",",
"annotations",
"=",
"self",
".... | Delete all objects in QuerySet. | [
"Delete",
"all",
"objects",
"in",
"QuerySet",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L307-L317 |
231,887 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.update | def update(self, **kwargs) -> "UpdateQuery":
"""
Update all objects in QuerySet with given kwargs.
"""
return UpdateQuery(
db=self._db,
model=self.model,
update_kwargs=kwargs,
q_objects=self._q_objects,
annotations=self._annotat... | python | def update(self, **kwargs) -> "UpdateQuery":
"""
Update all objects in QuerySet with given kwargs.
"""
return UpdateQuery(
db=self._db,
model=self.model,
update_kwargs=kwargs,
q_objects=self._q_objects,
annotations=self._annotat... | [
"def",
"update",
"(",
"self",
",",
"*",
"*",
"kwargs",
")",
"->",
"\"UpdateQuery\"",
":",
"return",
"UpdateQuery",
"(",
"db",
"=",
"self",
".",
"_db",
",",
"model",
"=",
"self",
".",
"model",
",",
"update_kwargs",
"=",
"kwargs",
",",
"q_objects",
"=",
... | Update all objects in QuerySet with given kwargs. | [
"Update",
"all",
"objects",
"in",
"QuerySet",
"with",
"given",
"kwargs",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L319-L330 |
231,888 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.count | def count(self) -> "CountQuery":
"""
Return count of objects in queryset instead of objects.
"""
return CountQuery(
db=self._db,
model=self.model,
q_objects=self._q_objects,
annotations=self._annotations,
custom_filters=self._cu... | python | def count(self) -> "CountQuery":
"""
Return count of objects in queryset instead of objects.
"""
return CountQuery(
db=self._db,
model=self.model,
q_objects=self._q_objects,
annotations=self._annotations,
custom_filters=self._cu... | [
"def",
"count",
"(",
"self",
")",
"->",
"\"CountQuery\"",
":",
"return",
"CountQuery",
"(",
"db",
"=",
"self",
".",
"_db",
",",
"model",
"=",
"self",
".",
"model",
",",
"q_objects",
"=",
"self",
".",
"_q_objects",
",",
"annotations",
"=",
"self",
".",
... | Return count of objects in queryset instead of objects. | [
"Return",
"count",
"of",
"objects",
"in",
"queryset",
"instead",
"of",
"objects",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L332-L342 |
231,889 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.first | def first(self) -> "QuerySet":
"""
Limit queryset to one object and return one object instead of list.
"""
queryset = self._clone()
queryset._limit = 1
queryset._single = True
return queryset | python | def first(self) -> "QuerySet":
"""
Limit queryset to one object and return one object instead of list.
"""
queryset = self._clone()
queryset._limit = 1
queryset._single = True
return queryset | [
"def",
"first",
"(",
"self",
")",
"->",
"\"QuerySet\"",
":",
"queryset",
"=",
"self",
".",
"_clone",
"(",
")",
"queryset",
".",
"_limit",
"=",
"1",
"queryset",
".",
"_single",
"=",
"True",
"return",
"queryset"
] | Limit queryset to one object and return one object instead of list. | [
"Limit",
"queryset",
"to",
"one",
"object",
"and",
"return",
"one",
"object",
"instead",
"of",
"list",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L351-L358 |
231,890 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.get | def get(self, *args, **kwargs) -> "QuerySet":
"""
Fetch exactly one object matching the parameters.
"""
queryset = self.filter(*args, **kwargs)
queryset._limit = 2
queryset._get = True
return queryset | python | def get(self, *args, **kwargs) -> "QuerySet":
"""
Fetch exactly one object matching the parameters.
"""
queryset = self.filter(*args, **kwargs)
queryset._limit = 2
queryset._get = True
return queryset | [
"def",
"get",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"->",
"\"QuerySet\"",
":",
"queryset",
"=",
"self",
".",
"filter",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"queryset",
".",
"_limit",
"=",
"2",
"queryset",
".",
"_... | Fetch exactly one object matching the parameters. | [
"Fetch",
"exactly",
"one",
"object",
"matching",
"the",
"parameters",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L360-L367 |
231,891 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.explain | async def explain(self) -> Any:
"""Fetch and return information about the query execution plan.
This is done by executing an ``EXPLAIN`` query whose exact prefix depends
on the database backend, as documented below.
- PostgreSQL: ``EXPLAIN (FORMAT JSON, VERBOSE) ...``
- SQLite:... | python | async def explain(self) -> Any:
"""Fetch and return information about the query execution plan.
This is done by executing an ``EXPLAIN`` query whose exact prefix depends
on the database backend, as documented below.
- PostgreSQL: ``EXPLAIN (FORMAT JSON, VERBOSE) ...``
- SQLite:... | [
"async",
"def",
"explain",
"(",
"self",
")",
"->",
"Any",
":",
"if",
"self",
".",
"_db",
"is",
"None",
":",
"self",
".",
"_db",
"=",
"self",
".",
"model",
".",
"_meta",
".",
"db",
"return",
"await",
"self",
".",
"_db",
".",
"executor_class",
"(",
... | Fetch and return information about the query execution plan.
This is done by executing an ``EXPLAIN`` query whose exact prefix depends
on the database backend, as documented below.
- PostgreSQL: ``EXPLAIN (FORMAT JSON, VERBOSE) ...``
- SQLite: ``EXPLAIN QUERY PLAN ...``
- MySQL... | [
"Fetch",
"and",
"return",
"information",
"about",
"the",
"query",
"execution",
"plan",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L393-L413 |
231,892 | tortoise/tortoise-orm | tortoise/queryset.py | QuerySet.using_db | def using_db(self, _db: BaseDBAsyncClient) -> "QuerySet":
"""
Executes query in provided db client.
Useful for transactions workaround.
"""
queryset = self._clone()
queryset._db = _db
return queryset | python | def using_db(self, _db: BaseDBAsyncClient) -> "QuerySet":
"""
Executes query in provided db client.
Useful for transactions workaround.
"""
queryset = self._clone()
queryset._db = _db
return queryset | [
"def",
"using_db",
"(",
"self",
",",
"_db",
":",
"BaseDBAsyncClient",
")",
"->",
"\"QuerySet\"",
":",
"queryset",
"=",
"self",
".",
"_clone",
"(",
")",
"queryset",
".",
"_db",
"=",
"_db",
"return",
"queryset"
] | Executes query in provided db client.
Useful for transactions workaround. | [
"Executes",
"query",
"in",
"provided",
"db",
"client",
".",
"Useful",
"for",
"transactions",
"workaround",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/queryset.py#L415-L422 |
231,893 | tortoise/tortoise-orm | tortoise/models.py | Model._check_unique_together | def _check_unique_together(cls):
"""Check the value of "unique_together" option."""
if cls._meta.unique_together is None:
return
if not isinstance(cls._meta.unique_together, (tuple, list)):
raise ConfigurationError(
"'{}.unique_together' must be a list or... | python | def _check_unique_together(cls):
"""Check the value of "unique_together" option."""
if cls._meta.unique_together is None:
return
if not isinstance(cls._meta.unique_together, (tuple, list)):
raise ConfigurationError(
"'{}.unique_together' must be a list or... | [
"def",
"_check_unique_together",
"(",
"cls",
")",
":",
"if",
"cls",
".",
"_meta",
".",
"unique_together",
"is",
"None",
":",
"return",
"if",
"not",
"isinstance",
"(",
"cls",
".",
"_meta",
".",
"unique_together",
",",
"(",
"tuple",
",",
"list",
")",
")",
... | Check the value of "unique_together" option. | [
"Check",
"the",
"value",
"of",
"unique_together",
"option",
"."
] | 7d16457731905e19d4d06ccd5b4ea16d4a9447b2 | https://github.com/tortoise/tortoise-orm/blob/7d16457731905e19d4d06ccd5b4ea16d4a9447b2/tortoise/models.py#L324-L357 |
231,894 | aerkalov/ebooklib | ebooklib/epub.py | write_epub | def write_epub(name, book, options=None):
"""
Creates epub file with the content defined in EpubBook.
>>> ebooklib.write_epub('book.epub', book)
:Args:
- name: file name for the output file
- book: instance of EpubBook
- options: extra opions as dictionary (optional)
"""
epub... | python | def write_epub(name, book, options=None):
"""
Creates epub file with the content defined in EpubBook.
>>> ebooklib.write_epub('book.epub', book)
:Args:
- name: file name for the output file
- book: instance of EpubBook
- options: extra opions as dictionary (optional)
"""
epub... | [
"def",
"write_epub",
"(",
"name",
",",
"book",
",",
"options",
"=",
"None",
")",
":",
"epub",
"=",
"EpubWriter",
"(",
"name",
",",
"book",
",",
"options",
")",
"epub",
".",
"process",
"(",
")",
"try",
":",
"epub",
".",
"write",
"(",
")",
"except",
... | Creates epub file with the content defined in EpubBook.
>>> ebooklib.write_epub('book.epub', book)
:Args:
- name: file name for the output file
- book: instance of EpubBook
- options: extra opions as dictionary (optional) | [
"Creates",
"epub",
"file",
"with",
"the",
"content",
"defined",
"in",
"EpubBook",
"."
] | 305f2dd7f02923ffabf9586a5d16266113d00c4a | https://github.com/aerkalov/ebooklib/blob/305f2dd7f02923ffabf9586a5d16266113d00c4a/ebooklib/epub.py#L1705-L1723 |
231,895 | aerkalov/ebooklib | ebooklib/epub.py | read_epub | def read_epub(name, options=None):
"""
Creates new instance of EpubBook with the content defined in the input file.
>>> book = ebooklib.read_epub('book.epub')
:Args:
- name: full path to the input file
- options: extra options as dictionary (optional)
:Returns:
Instance of EpubB... | python | def read_epub(name, options=None):
"""
Creates new instance of EpubBook with the content defined in the input file.
>>> book = ebooklib.read_epub('book.epub')
:Args:
- name: full path to the input file
- options: extra options as dictionary (optional)
:Returns:
Instance of EpubB... | [
"def",
"read_epub",
"(",
"name",
",",
"options",
"=",
"None",
")",
":",
"reader",
"=",
"EpubReader",
"(",
"name",
",",
"options",
")",
"book",
"=",
"reader",
".",
"load",
"(",
")",
"reader",
".",
"process",
"(",
")",
"return",
"book"
] | Creates new instance of EpubBook with the content defined in the input file.
>>> book = ebooklib.read_epub('book.epub')
:Args:
- name: full path to the input file
- options: extra options as dictionary (optional)
:Returns:
Instance of EpubBook. | [
"Creates",
"new",
"instance",
"of",
"EpubBook",
"with",
"the",
"content",
"defined",
"in",
"the",
"input",
"file",
"."
] | 305f2dd7f02923ffabf9586a5d16266113d00c4a | https://github.com/aerkalov/ebooklib/blob/305f2dd7f02923ffabf9586a5d16266113d00c4a/ebooklib/epub.py#L1728-L1746 |
231,896 | aerkalov/ebooklib | ebooklib/epub.py | EpubItem.get_type | def get_type(self):
"""
Guess type according to the file extension. Might not be the best way how to do it, but it works for now.
Items can be of type:
- ITEM_UNKNOWN = 0
- ITEM_IMAGE = 1
- ITEM_STYLE = 2
- ITEM_SCRIPT = 3
- ITEM_NAVIGATION = 4
... | python | def get_type(self):
"""
Guess type according to the file extension. Might not be the best way how to do it, but it works for now.
Items can be of type:
- ITEM_UNKNOWN = 0
- ITEM_IMAGE = 1
- ITEM_STYLE = 2
- ITEM_SCRIPT = 3
- ITEM_NAVIGATION = 4
... | [
"def",
"get_type",
"(",
"self",
")",
":",
"_",
",",
"ext",
"=",
"zip_path",
".",
"splitext",
"(",
"self",
".",
"get_name",
"(",
")",
")",
"ext",
"=",
"ext",
".",
"lower",
"(",
")",
"for",
"uid",
",",
"ext_list",
"in",
"six",
".",
"iteritems",
"("... | Guess type according to the file extension. Might not be the best way how to do it, but it works for now.
Items can be of type:
- ITEM_UNKNOWN = 0
- ITEM_IMAGE = 1
- ITEM_STYLE = 2
- ITEM_SCRIPT = 3
- ITEM_NAVIGATION = 4
- ITEM_VECTOR = 5
- ... | [
"Guess",
"type",
"according",
"to",
"the",
"file",
"extension",
".",
"Might",
"not",
"be",
"the",
"best",
"way",
"how",
"to",
"do",
"it",
"but",
"it",
"works",
"for",
"now",
"."
] | 305f2dd7f02923ffabf9586a5d16266113d00c4a | https://github.com/aerkalov/ebooklib/blob/305f2dd7f02923ffabf9586a5d16266113d00c4a/ebooklib/epub.py#L158-L187 |
231,897 | aerkalov/ebooklib | ebooklib/epub.py | EpubHtml.add_link | def add_link(self, **kwgs):
"""
Add additional link to the document. Links will be embeded only inside of this document.
>>> add_link(href='styles.css', rel='stylesheet', type='text/css')
"""
self.links.append(kwgs)
if kwgs.get('type') == 'text/javascript':
i... | python | def add_link(self, **kwgs):
"""
Add additional link to the document. Links will be embeded only inside of this document.
>>> add_link(href='styles.css', rel='stylesheet', type='text/css')
"""
self.links.append(kwgs)
if kwgs.get('type') == 'text/javascript':
i... | [
"def",
"add_link",
"(",
"self",
",",
"*",
"*",
"kwgs",
")",
":",
"self",
".",
"links",
".",
"append",
"(",
"kwgs",
")",
"if",
"kwgs",
".",
"get",
"(",
"'type'",
")",
"==",
"'text/javascript'",
":",
"if",
"'scripted'",
"not",
"in",
"self",
".",
"pro... | Add additional link to the document. Links will be embeded only inside of this document.
>>> add_link(href='styles.css', rel='stylesheet', type='text/css') | [
"Add",
"additional",
"link",
"to",
"the",
"document",
".",
"Links",
"will",
"be",
"embeded",
"only",
"inside",
"of",
"this",
"document",
"."
] | 305f2dd7f02923ffabf9586a5d16266113d00c4a | https://github.com/aerkalov/ebooklib/blob/305f2dd7f02923ffabf9586a5d16266113d00c4a/ebooklib/epub.py#L299-L308 |
231,898 | aerkalov/ebooklib | ebooklib/epub.py | EpubHtml.get_links_of_type | def get_links_of_type(self, link_type):
"""
Returns list of additional links of specific type.
:Returns:
As tuple returns list of links.
"""
return (link for link in self.links if link.get('type', '') == link_type) | python | def get_links_of_type(self, link_type):
"""
Returns list of additional links of specific type.
:Returns:
As tuple returns list of links.
"""
return (link for link in self.links if link.get('type', '') == link_type) | [
"def",
"get_links_of_type",
"(",
"self",
",",
"link_type",
")",
":",
"return",
"(",
"link",
"for",
"link",
"in",
"self",
".",
"links",
"if",
"link",
".",
"get",
"(",
"'type'",
",",
"''",
")",
"==",
"link_type",
")"
] | Returns list of additional links of specific type.
:Returns:
As tuple returns list of links. | [
"Returns",
"list",
"of",
"additional",
"links",
"of",
"specific",
"type",
"."
] | 305f2dd7f02923ffabf9586a5d16266113d00c4a | https://github.com/aerkalov/ebooklib/blob/305f2dd7f02923ffabf9586a5d16266113d00c4a/ebooklib/epub.py#L319-L326 |
231,899 | aerkalov/ebooklib | ebooklib/epub.py | EpubHtml.add_item | def add_item(self, item):
"""
Add other item to this document. It will create additional links according to the item type.
:Args:
- item: item we want to add defined as instance of EpubItem
"""
if item.get_type() == ebooklib.ITEM_STYLE:
self.add_link(href=i... | python | def add_item(self, item):
"""
Add other item to this document. It will create additional links according to the item type.
:Args:
- item: item we want to add defined as instance of EpubItem
"""
if item.get_type() == ebooklib.ITEM_STYLE:
self.add_link(href=i... | [
"def",
"add_item",
"(",
"self",
",",
"item",
")",
":",
"if",
"item",
".",
"get_type",
"(",
")",
"==",
"ebooklib",
".",
"ITEM_STYLE",
":",
"self",
".",
"add_link",
"(",
"href",
"=",
"item",
".",
"get_name",
"(",
")",
",",
"rel",
"=",
"'stylesheet'",
... | Add other item to this document. It will create additional links according to the item type.
:Args:
- item: item we want to add defined as instance of EpubItem | [
"Add",
"other",
"item",
"to",
"this",
"document",
".",
"It",
"will",
"create",
"additional",
"links",
"according",
"to",
"the",
"item",
"type",
"."
] | 305f2dd7f02923ffabf9586a5d16266113d00c4a | https://github.com/aerkalov/ebooklib/blob/305f2dd7f02923ffabf9586a5d16266113d00c4a/ebooklib/epub.py#L328-L339 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.