partition stringclasses 3
values | func_name stringlengths 1 134 | docstring stringlengths 1 46.9k | path stringlengths 4 223 | original_string stringlengths 75 104k | code stringlengths 75 104k | docstring_tokens listlengths 1 1.97k | repo stringlengths 7 55 | language stringclasses 1
value | url stringlengths 87 315 | code_tokens listlengths 19 28.4k | sha stringlengths 40 40 |
|---|---|---|---|---|---|---|---|---|---|---|---|
test | round_mantissa | Round floating point number(s) mantissa to given number of digits.
Integers are not altered. The mantissa used is that of the floating point
number(s) when expressed in `normalized scientific notation
<https://en.wikipedia.org/wiki/Scientific_notation#Normalized_notation>`_
:param arg: Input data
... | peng/functions.py | def round_mantissa(arg, decimals=0):
"""
Round floating point number(s) mantissa to given number of digits.
Integers are not altered. The mantissa used is that of the floating point
number(s) when expressed in `normalized scientific notation
<https://en.wikipedia.org/wiki/Scientific_notation#Normal... | def round_mantissa(arg, decimals=0):
"""
Round floating point number(s) mantissa to given number of digits.
Integers are not altered. The mantissa used is that of the floating point
number(s) when expressed in `normalized scientific notation
<https://en.wikipedia.org/wiki/Scientific_notation#Normal... | [
"Round",
"floating",
"point",
"number",
"(",
"s",
")",
"mantissa",
"to",
"given",
"number",
"of",
"digits",
"."
] | pmacosta/peng | python | https://github.com/pmacosta/peng/blob/976935377adaa3de26fc5677aceb2cdfbd6f93a7/peng/functions.py#L764-L801 | [
"def",
"round_mantissa",
"(",
"arg",
",",
"decimals",
"=",
"0",
")",
":",
"if",
"arg",
"is",
"None",
":",
"return",
"arg",
"if",
"isinstance",
"(",
"arg",
",",
"np",
".",
"ndarray",
")",
":",
"foi",
"=",
"[",
"isinstance",
"(",
"item",
",",
"int",
... | 976935377adaa3de26fc5677aceb2cdfbd6f93a7 |
test | pprint_vector | r"""
Format a list of numbers (vector) or a Numpy vector for printing.
If the argument **vector** is :code:`None` the string :code:`'None'` is
returned
:param vector: Vector to pretty print or None
:type vector: list of integers or floats, Numpy vector or None
:param limit: Flag that indicat... | peng/functions.py | def pprint_vector(vector, limit=False, width=None, indent=0, eng=False, frac_length=3):
r"""
Format a list of numbers (vector) or a Numpy vector for printing.
If the argument **vector** is :code:`None` the string :code:`'None'` is
returned
:param vector: Vector to pretty print or None
:type v... | def pprint_vector(vector, limit=False, width=None, indent=0, eng=False, frac_length=3):
r"""
Format a list of numbers (vector) or a Numpy vector for printing.
If the argument **vector** is :code:`None` the string :code:`'None'` is
returned
:param vector: Vector to pretty print or None
:type v... | [
"r",
"Format",
"a",
"list",
"of",
"numbers",
"(",
"vector",
")",
"or",
"a",
"Numpy",
"vector",
"for",
"printing",
"."
] | pmacosta/peng | python | https://github.com/pmacosta/peng/blob/976935377adaa3de26fc5677aceb2cdfbd6f93a7/peng/functions.py#L804-L1051 | [
"def",
"pprint_vector",
"(",
"vector",
",",
"limit",
"=",
"False",
",",
"width",
"=",
"None",
",",
"indent",
"=",
"0",
",",
"eng",
"=",
"False",
",",
"frac_length",
"=",
"3",
")",
":",
"# pylint: disable=R0912,R0913",
"num_digits",
"=",
"12",
"approx",
"... | 976935377adaa3de26fc5677aceb2cdfbd6f93a7 |
test | to_scientific_string | Convert number or number string to a number string in scientific notation.
Full precision is maintained if the number is represented as a string
:param number: Number to convert
:type number: number or string
:param frac_length: Number of digits of fractional part, None indicates
... | peng/functions.py | def to_scientific_string(number, frac_length=None, exp_length=None, sign_always=False):
"""
Convert number or number string to a number string in scientific notation.
Full precision is maintained if the number is represented as a string
:param number: Number to convert
:type number: number or str... | def to_scientific_string(number, frac_length=None, exp_length=None, sign_always=False):
"""
Convert number or number string to a number string in scientific notation.
Full precision is maintained if the number is represented as a string
:param number: Number to convert
:type number: number or str... | [
"Convert",
"number",
"or",
"number",
"string",
"to",
"a",
"number",
"string",
"in",
"scientific",
"notation",
"."
] | pmacosta/peng | python | https://github.com/pmacosta/peng/blob/976935377adaa3de26fc5677aceb2cdfbd6f93a7/peng/functions.py#L1054-L1123 | [
"def",
"to_scientific_string",
"(",
"number",
",",
"frac_length",
"=",
"None",
",",
"exp_length",
"=",
"None",
",",
"sign_always",
"=",
"False",
")",
":",
"# pylint: disable=W0702",
"try",
":",
"number",
"=",
"-",
"1e20",
"if",
"np",
".",
"isneginf",
"(",
... | 976935377adaa3de26fc5677aceb2cdfbd6f93a7 |
test | to_scientific_tuple | Return mantissa and exponent of a number in scientific notation.
Full precision is maintained if the number is represented as a string
:param number: Number
:type number: integer, float or string
:rtype: named tuple in which the first item is the mantissa (*string*)
and the second item i... | peng/functions.py | def to_scientific_tuple(number):
"""
Return mantissa and exponent of a number in scientific notation.
Full precision is maintained if the number is represented as a string
:param number: Number
:type number: integer, float or string
:rtype: named tuple in which the first item is the mantissa... | def to_scientific_tuple(number):
"""
Return mantissa and exponent of a number in scientific notation.
Full precision is maintained if the number is represented as a string
:param number: Number
:type number: integer, float or string
:rtype: named tuple in which the first item is the mantissa... | [
"Return",
"mantissa",
"and",
"exponent",
"of",
"a",
"number",
"in",
"scientific",
"notation",
"."
] | pmacosta/peng | python | https://github.com/pmacosta/peng/blob/976935377adaa3de26fc5677aceb2cdfbd6f93a7/peng/functions.py#L1126-L1174 | [
"def",
"to_scientific_tuple",
"(",
"number",
")",
":",
"# pylint: disable=W0632",
"convert",
"=",
"not",
"isinstance",
"(",
"number",
",",
"str",
")",
"# Detect zero and return, simplifies subsequent algorithm",
"if",
"(",
"convert",
"and",
"(",
"number",
"==",
"0",
... | 976935377adaa3de26fc5677aceb2cdfbd6f93a7 |
test | find_sourcemap_comment | Seeks and removes the sourcemap comment. If found, the sourcemap line is
returned.
Bundled output files can have massive amounts of lines, and the sourceMap
comment is always at the end. So, to extract it efficiently, we read out the
lines of the file starting from the end. We look back at most 2 lines... | systemjs/base.py | def find_sourcemap_comment(filepath, block_size=100):
"""
Seeks and removes the sourcemap comment. If found, the sourcemap line is
returned.
Bundled output files can have massive amounts of lines, and the sourceMap
comment is always at the end. So, to extract it efficiently, we read out the
lin... | def find_sourcemap_comment(filepath, block_size=100):
"""
Seeks and removes the sourcemap comment. If found, the sourcemap line is
returned.
Bundled output files can have massive amounts of lines, and the sourceMap
comment is always at the end. So, to extract it efficiently, we read out the
lin... | [
"Seeks",
"and",
"removes",
"the",
"sourcemap",
"comment",
".",
"If",
"found",
"the",
"sourcemap",
"line",
"is",
"returned",
"."
] | sergei-maertens/django-systemjs | python | https://github.com/sergei-maertens/django-systemjs/blob/efd4a3862a39d9771609a25a5556f36023cf6e5c/systemjs/base.py#L305-L374 | [
"def",
"find_sourcemap_comment",
"(",
"filepath",
",",
"block_size",
"=",
"100",
")",
":",
"MAX_TRACKBACK",
"=",
"2",
"# look back at most 2 lines, catching potential blank line at the end",
"block_number",
"=",
"-",
"1",
"# blocks of size block_size, in reverse order starting fr... | efd4a3862a39d9771609a25a5556f36023cf6e5c |
test | SystemBundle.get_paths | Return a tuple with the absolute path and relative path (relative to STATIC_URL) | systemjs/base.py | def get_paths(self):
"""
Return a tuple with the absolute path and relative path (relative to STATIC_URL)
"""
outfile = self.get_outfile()
rel_path = os.path.relpath(outfile, settings.STATIC_ROOT)
return outfile, rel_path | def get_paths(self):
"""
Return a tuple with the absolute path and relative path (relative to STATIC_URL)
"""
outfile = self.get_outfile()
rel_path = os.path.relpath(outfile, settings.STATIC_ROOT)
return outfile, rel_path | [
"Return",
"a",
"tuple",
"with",
"the",
"absolute",
"path",
"and",
"relative",
"path",
"(",
"relative",
"to",
"STATIC_URL",
")"
] | sergei-maertens/django-systemjs | python | https://github.com/sergei-maertens/django-systemjs/blob/efd4a3862a39d9771609a25a5556f36023cf6e5c/systemjs/base.py#L122-L128 | [
"def",
"get_paths",
"(",
"self",
")",
":",
"outfile",
"=",
"self",
".",
"get_outfile",
"(",
")",
"rel_path",
"=",
"os",
".",
"path",
".",
"relpath",
"(",
"outfile",
",",
"settings",
".",
"STATIC_ROOT",
")",
"return",
"outfile",
",",
"rel_path"
] | efd4a3862a39d9771609a25a5556f36023cf6e5c |
test | SystemBundle.needs_ext | Check whether `self.app` is missing the '.js' extension and if it needs it. | systemjs/base.py | def needs_ext(self):
"""
Check whether `self.app` is missing the '.js' extension and if it needs it.
"""
if settings.SYSTEMJS_DEFAULT_JS_EXTENSIONS:
name, ext = posixpath.splitext(self.app)
if not ext:
return True
return False | def needs_ext(self):
"""
Check whether `self.app` is missing the '.js' extension and if it needs it.
"""
if settings.SYSTEMJS_DEFAULT_JS_EXTENSIONS:
name, ext = posixpath.splitext(self.app)
if not ext:
return True
return False | [
"Check",
"whether",
"self",
".",
"app",
"is",
"missing",
"the",
".",
"js",
"extension",
"and",
"if",
"it",
"needs",
"it",
"."
] | sergei-maertens/django-systemjs | python | https://github.com/sergei-maertens/django-systemjs/blob/efd4a3862a39d9771609a25a5556f36023cf6e5c/systemjs/base.py#L130-L138 | [
"def",
"needs_ext",
"(",
"self",
")",
":",
"if",
"settings",
".",
"SYSTEMJS_DEFAULT_JS_EXTENSIONS",
":",
"name",
",",
"ext",
"=",
"posixpath",
".",
"splitext",
"(",
"self",
".",
"app",
")",
"if",
"not",
"ext",
":",
"return",
"True",
"return",
"False"
] | efd4a3862a39d9771609a25a5556f36023cf6e5c |
test | SystemBundle.bundle | Bundle the app and return the static url to the bundle. | systemjs/base.py | def bundle(self):
"""
Bundle the app and return the static url to the bundle.
"""
outfile, rel_path = self.get_paths()
options = self.opts
if self.system._has_jspm_log():
self.command += ' --log {log}'
options.setdefault('log', 'err')
if ... | def bundle(self):
"""
Bundle the app and return the static url to the bundle.
"""
outfile, rel_path = self.get_paths()
options = self.opts
if self.system._has_jspm_log():
self.command += ' --log {log}'
options.setdefault('log', 'err')
if ... | [
"Bundle",
"the",
"app",
"and",
"return",
"the",
"static",
"url",
"to",
"the",
"bundle",
"."
] | sergei-maertens/django-systemjs | python | https://github.com/sergei-maertens/django-systemjs/blob/efd4a3862a39d9771609a25a5556f36023cf6e5c/systemjs/base.py#L140-L185 | [
"def",
"bundle",
"(",
"self",
")",
":",
"outfile",
",",
"rel_path",
"=",
"self",
".",
"get_paths",
"(",
")",
"options",
"=",
"self",
".",
"opts",
"if",
"self",
".",
"system",
".",
"_has_jspm_log",
"(",
")",
":",
"self",
".",
"command",
"+=",
"' --log... | efd4a3862a39d9771609a25a5556f36023cf6e5c |
test | SystemTracer.trace | Trace the dependencies for app.
A tracer-instance is shortlived, and re-tracing the same app should
yield the same results. Since tracing is an expensive process, cache
the result on the tracer instance. | systemjs/base.py | def trace(self, app):
"""
Trace the dependencies for app.
A tracer-instance is shortlived, and re-tracing the same app should
yield the same results. Since tracing is an expensive process, cache
the result on the tracer instance.
"""
if app not in self._trace_cac... | def trace(self, app):
"""
Trace the dependencies for app.
A tracer-instance is shortlived, and re-tracing the same app should
yield the same results. Since tracing is an expensive process, cache
the result on the tracer instance.
"""
if app not in self._trace_cac... | [
"Trace",
"the",
"dependencies",
"for",
"app",
"."
] | sergei-maertens/django-systemjs | python | https://github.com/sergei-maertens/django-systemjs/blob/efd4a3862a39d9771609a25a5556f36023cf6e5c/systemjs/base.py#L210-L228 | [
"def",
"trace",
"(",
"self",
",",
"app",
")",
":",
"if",
"app",
"not",
"in",
"self",
".",
"_trace_cache",
":",
"process",
"=",
"subprocess",
".",
"Popen",
"(",
"\"trace-deps.js {}\"",
".",
"format",
"(",
"app",
")",
",",
"shell",
"=",
"True",
",",
"s... | efd4a3862a39d9771609a25a5556f36023cf6e5c |
test | SystemTracer.hashes_match | Compares the app deptree file hashes with the hashes stored in the
cache. | systemjs/base.py | def hashes_match(self, dep_tree):
"""
Compares the app deptree file hashes with the hashes stored in the
cache.
"""
hashes = self.get_hashes()
for module, info in dep_tree.items():
md5 = self.get_hash(info['path'])
if md5 != hashes[info['path']]:
... | def hashes_match(self, dep_tree):
"""
Compares the app deptree file hashes with the hashes stored in the
cache.
"""
hashes = self.get_hashes()
for module, info in dep_tree.items():
md5 = self.get_hash(info['path'])
if md5 != hashes[info['path']]:
... | [
"Compares",
"the",
"app",
"deptree",
"file",
"hashes",
"with",
"the",
"hashes",
"stored",
"in",
"the",
"cache",
"."
] | sergei-maertens/django-systemjs | python | https://github.com/sergei-maertens/django-systemjs/blob/efd4a3862a39d9771609a25a5556f36023cf6e5c/systemjs/base.py#L284-L294 | [
"def",
"hashes_match",
"(",
"self",
",",
"dep_tree",
")",
":",
"hashes",
"=",
"self",
".",
"get_hashes",
"(",
")",
"for",
"module",
",",
"info",
"in",
"dep_tree",
".",
"items",
"(",
")",
":",
"md5",
"=",
"self",
".",
"get_hash",
"(",
"info",
"[",
"... | efd4a3862a39d9771609a25a5556f36023cf6e5c |
test | format_hexdump | Convert the bytes object to a hexdump.
The output format will be:
<offset, 4-byte> <16-bytes of output separated by 1 space> <16 ascii characters> | typedargs/types/bytes.py | def format_hexdump(arg):
"""Convert the bytes object to a hexdump.
The output format will be:
<offset, 4-byte> <16-bytes of output separated by 1 space> <16 ascii characters>
"""
line = ''
for i in range(0, len(arg), 16):
if i > 0:
line += '\n'
chunk = arg[i:i +... | def format_hexdump(arg):
"""Convert the bytes object to a hexdump.
The output format will be:
<offset, 4-byte> <16-bytes of output separated by 1 space> <16 ascii characters>
"""
line = ''
for i in range(0, len(arg), 16):
if i > 0:
line += '\n'
chunk = arg[i:i +... | [
"Convert",
"the",
"bytes",
"object",
"to",
"a",
"hexdump",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/types/bytes.py#L47-L72 | [
"def",
"format_hexdump",
"(",
"arg",
")",
":",
"line",
"=",
"''",
"for",
"i",
"in",
"range",
"(",
"0",
",",
"len",
"(",
"arg",
")",
",",
"16",
")",
":",
"if",
"i",
">",
"0",
":",
"line",
"+=",
"'\\n'",
"chunk",
"=",
"arg",
"[",
"i",
":",
"i... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | parse_docstring | Parse a docstring into ParameterInfo and ReturnInfo objects. | typedargs/doc_annotate.py | def parse_docstring(doc):
"""Parse a docstring into ParameterInfo and ReturnInfo objects."""
doc = inspect.cleandoc(doc)
lines = doc.split('\n')
section = None
section_indent = None
params = {}
returns = None
for line in lines:
line = line.rstrip()
if len(line) == 0:
... | def parse_docstring(doc):
"""Parse a docstring into ParameterInfo and ReturnInfo objects."""
doc = inspect.cleandoc(doc)
lines = doc.split('\n')
section = None
section_indent = None
params = {}
returns = None
for line in lines:
line = line.rstrip()
if len(line) == 0:
... | [
"Parse",
"a",
"docstring",
"into",
"ParameterInfo",
"and",
"ReturnInfo",
"objects",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/doc_annotate.py#L7-L50 | [
"def",
"parse_docstring",
"(",
"doc",
")",
":",
"doc",
"=",
"inspect",
".",
"cleandoc",
"(",
"doc",
")",
"lines",
"=",
"doc",
".",
"split",
"(",
"'\\n'",
")",
"section",
"=",
"None",
"section_indent",
"=",
"None",
"params",
"=",
"{",
"}",
"returns",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell.valid_identifiers | Get a list of all valid identifiers for the current context.
Returns:
list(str): A list of all of the valid identifiers for this context | typedargs/shell.py | def valid_identifiers(self):
"""Get a list of all valid identifiers for the current context.
Returns:
list(str): A list of all of the valid identifiers for this context
"""
funcs = list(utils.find_all(self.contexts[-1])) + list(self.builtins)
return funcs | def valid_identifiers(self):
"""Get a list of all valid identifiers for the current context.
Returns:
list(str): A list of all of the valid identifiers for this context
"""
funcs = list(utils.find_all(self.contexts[-1])) + list(self.builtins)
return funcs | [
"Get",
"a",
"list",
"of",
"all",
"valid",
"identifiers",
"for",
"the",
"current",
"context",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L95-L103 | [
"def",
"valid_identifiers",
"(",
"self",
")",
":",
"funcs",
"=",
"list",
"(",
"utils",
".",
"find_all",
"(",
"self",
".",
"contexts",
"[",
"-",
"1",
"]",
")",
")",
"+",
"list",
"(",
"self",
".",
"builtins",
")",
"return",
"funcs"
] | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell._deferred_add | Lazily load a callable.
Perform a lazy import of a context so that we don't have a huge initial startup time
loading all of the modules that someone might want even though they probably only
will use a few of them. | typedargs/shell.py | def _deferred_add(cls, add_action):
"""Lazily load a callable.
Perform a lazy import of a context so that we don't have a huge initial startup time
loading all of the modules that someone might want even though they probably only
will use a few of them.
"""
module, _, o... | def _deferred_add(cls, add_action):
"""Lazily load a callable.
Perform a lazy import of a context so that we don't have a huge initial startup time
loading all of the modules that someone might want even though they probably only
will use a few of them.
"""
module, _, o... | [
"Lazily",
"load",
"a",
"callable",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L106-L124 | [
"def",
"_deferred_add",
"(",
"cls",
",",
"add_action",
")",
":",
"module",
",",
"_",
",",
"obj",
"=",
"add_action",
".",
"partition",
"(",
"','",
")",
"mod",
"=",
"importlib",
".",
"import_module",
"(",
"module",
")",
"if",
"obj",
"==",
"\"\"",
":",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell._split_line | Split a line into arguments using shlex and a dequoting routine. | typedargs/shell.py | def _split_line(self, line):
"""Split a line into arguments using shlex and a dequoting routine."""
parts = shlex.split(line, posix=self.posix_lex)
if not self.posix_lex:
parts = [self._remove_quotes(x) for x in parts]
return parts | def _split_line(self, line):
"""Split a line into arguments using shlex and a dequoting routine."""
parts = shlex.split(line, posix=self.posix_lex)
if not self.posix_lex:
parts = [self._remove_quotes(x) for x in parts]
return parts | [
"Split",
"a",
"line",
"into",
"arguments",
"using",
"shlex",
"and",
"a",
"dequoting",
"routine",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L133-L140 | [
"def",
"_split_line",
"(",
"self",
",",
"line",
")",
":",
"parts",
"=",
"shlex",
".",
"split",
"(",
"line",
",",
"posix",
"=",
"self",
".",
"posix_lex",
")",
"if",
"not",
"self",
".",
"posix_lex",
":",
"parts",
"=",
"[",
"self",
".",
"_remove_quotes"... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell._check_initialize_context | Check if our context matches something that we have initialization commands
for. If so, run them to initialize the context before proceeding with other
commands. | typedargs/shell.py | def _check_initialize_context(self):
"""
Check if our context matches something that we have initialization commands
for. If so, run them to initialize the context before proceeding with other
commands.
"""
path = ".".join([annotate.context_name(x) for x in self.context... | def _check_initialize_context(self):
"""
Check if our context matches something that we have initialization commands
for. If so, run them to initialize the context before proceeding with other
commands.
"""
path = ".".join([annotate.context_name(x) for x in self.context... | [
"Check",
"if",
"our",
"context",
"matches",
"something",
"that",
"we",
"have",
"initialization",
"commands",
"for",
".",
"If",
"so",
"run",
"them",
"to",
"initialize",
"the",
"context",
"before",
"proceeding",
"with",
"other",
"commands",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L142-L162 | [
"def",
"_check_initialize_context",
"(",
"self",
")",
":",
"path",
"=",
"\".\"",
".",
"join",
"(",
"[",
"annotate",
".",
"context_name",
"(",
"x",
")",
"for",
"x",
"in",
"self",
".",
"contexts",
"]",
")",
"#Make sure we don't clutter up the output with return va... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell._builtin_help | Return help information for a context or function. | typedargs/shell.py | def _builtin_help(self, args):
"""Return help information for a context or function."""
if len(args) == 0:
return self.list_dir(self.contexts[-1])
if len(args) == 1:
func = self.find_function(self.contexts[-1], args[0])
return annotate.get_help(func)
... | def _builtin_help(self, args):
"""Return help information for a context or function."""
if len(args) == 0:
return self.list_dir(self.contexts[-1])
if len(args) == 1:
func = self.find_function(self.contexts[-1], args[0])
return annotate.get_help(func)
... | [
"Return",
"help",
"information",
"for",
"a",
"context",
"or",
"function",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L176-L187 | [
"def",
"_builtin_help",
"(",
"self",
",",
"args",
")",
":",
"if",
"len",
"(",
"args",
")",
"==",
"0",
":",
"return",
"self",
".",
"list_dir",
"(",
"self",
".",
"contexts",
"[",
"-",
"1",
"]",
")",
"if",
"len",
"(",
"args",
")",
"==",
"1",
":",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell.find_function | Find a function in the given context by name.
This function will first search the list of builtins and if the
desired function is not a builtin, it will continue to search
the given context.
Args:
context (object): A dict or class that is a typedargs context
fun... | typedargs/shell.py | def find_function(self, context, funname):
"""Find a function in the given context by name.
This function will first search the list of builtins and if the
desired function is not a builtin, it will continue to search
the given context.
Args:
context (object): A dic... | def find_function(self, context, funname):
"""Find a function in the given context by name.
This function will first search the list of builtins and if the
desired function is not a builtin, it will continue to search
the given context.
Args:
context (object): A dic... | [
"Find",
"a",
"function",
"in",
"the",
"given",
"context",
"by",
"name",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L189-L222 | [
"def",
"find_function",
"(",
"self",
",",
"context",
",",
"funname",
")",
":",
"if",
"funname",
"in",
"self",
".",
"builtins",
":",
"return",
"self",
".",
"builtins",
"[",
"funname",
"]",
"func",
"=",
"None",
"if",
"isinstance",
"(",
"context",
",",
"d... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell.list_dir | Return a listing of all of the functions in this context including builtins.
Args:
context (object): The context to print a directory for.
Returns:
str | typedargs/shell.py | def list_dir(self, context):
"""Return a listing of all of the functions in this context including builtins.
Args:
context (object): The context to print a directory for.
Returns:
str
"""
doc = inspect.getdoc(context)
listing = ""
listi... | def list_dir(self, context):
"""Return a listing of all of the functions in this context including builtins.
Args:
context (object): The context to print a directory for.
Returns:
str
"""
doc = inspect.getdoc(context)
listing = ""
listi... | [
"Return",
"a",
"listing",
"of",
"all",
"of",
"the",
"functions",
"in",
"this",
"context",
"including",
"builtins",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L224-L277 | [
"def",
"list_dir",
"(",
"self",
",",
"context",
")",
":",
"doc",
"=",
"inspect",
".",
"getdoc",
"(",
"context",
")",
"listing",
"=",
"\"\"",
"listing",
"+=",
"\"\\n\"",
"listing",
"+=",
"annotate",
".",
"context_name",
"(",
"context",
")",
"+",
"\"\\n\""... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell._is_flag | Check if an argument is a flag.
A flag starts with - or -- and the next character must be a letter
followed by letters, numbers, - or _. Currently we only check the
alpha'ness of the first non-dash character to make sure we're not just
looking at a negative number.
Returns:
... | typedargs/shell.py | def _is_flag(cls, arg):
"""Check if an argument is a flag.
A flag starts with - or -- and the next character must be a letter
followed by letters, numbers, - or _. Currently we only check the
alpha'ness of the first non-dash character to make sure we're not just
looking at a ne... | def _is_flag(cls, arg):
"""Check if an argument is a flag.
A flag starts with - or -- and the next character must be a letter
followed by letters, numbers, - or _. Currently we only check the
alpha'ness of the first non-dash character to make sure we're not just
looking at a ne... | [
"Check",
"if",
"an",
"argument",
"is",
"a",
"flag",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L280-L306 | [
"def",
"_is_flag",
"(",
"cls",
",",
"arg",
")",
":",
"if",
"arg",
"==",
"'--'",
":",
"return",
"False",
"if",
"not",
"arg",
".",
"startswith",
"(",
"'-'",
")",
":",
"return",
"False",
"if",
"arg",
".",
"startswith",
"(",
"'--'",
")",
":",
"first_ch... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell.process_arguments | Process arguments from the command line into positional and kw args.
Arguments are consumed until the argument spec for the function is filled
or a -- is found or there are no more arguments. Keyword arguments can be
specified using --field=value, -f value or --field value. Positional
... | typedargs/shell.py | def process_arguments(self, func, args):
"""Process arguments from the command line into positional and kw args.
Arguments are consumed until the argument spec for the function is filled
or a -- is found or there are no more arguments. Keyword arguments can be
specified using --field=v... | def process_arguments(self, func, args):
"""Process arguments from the command line into positional and kw args.
Arguments are consumed until the argument spec for the function is filled
or a -- is found or there are no more arguments. Keyword arguments can be
specified using --field=v... | [
"Process",
"arguments",
"from",
"the",
"command",
"line",
"into",
"positional",
"and",
"kw",
"args",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L308-L380 | [
"def",
"process_arguments",
"(",
"self",
",",
"func",
",",
"args",
")",
":",
"pos_args",
"=",
"[",
"]",
"kw_args",
"=",
"{",
"}",
"while",
"len",
"(",
"args",
")",
">",
"0",
":",
"if",
"func",
".",
"metadata",
".",
"spec_filled",
"(",
"pos_args",
"... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell._extract_arg_value | Try to find the value for a keyword argument. | typedargs/shell.py | def _extract_arg_value(cls, arg_name, arg_type, remaining):
"""Try to find the value for a keyword argument."""
next_arg = None
should_consume = False
if len(remaining) > 0:
next_arg = remaining[0]
should_consume = True
if next_arg == '--':
... | def _extract_arg_value(cls, arg_name, arg_type, remaining):
"""Try to find the value for a keyword argument."""
next_arg = None
should_consume = False
if len(remaining) > 0:
next_arg = remaining[0]
should_consume = True
if next_arg == '--':
... | [
"Try",
"to",
"find",
"the",
"value",
"for",
"a",
"keyword",
"argument",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L383-L409 | [
"def",
"_extract_arg_value",
"(",
"cls",
",",
"arg_name",
",",
"arg_type",
",",
"remaining",
")",
":",
"next_arg",
"=",
"None",
"should_consume",
"=",
"False",
"if",
"len",
"(",
"remaining",
")",
">",
"0",
":",
"next_arg",
"=",
"remaining",
"[",
"0",
"]"... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell.invoke_one | Invoke a function given a list of arguments with the function listed first.
The function is searched for using the current context on the context stack
and its annotated type information is used to convert all of the string parameters
passed in line to appropriate python types.
Args:
... | typedargs/shell.py | def invoke_one(self, line):
"""Invoke a function given a list of arguments with the function listed first.
The function is searched for using the current context on the context stack
and its annotated type information is used to convert all of the string parameters
passed in line to app... | def invoke_one(self, line):
"""Invoke a function given a list of arguments with the function listed first.
The function is searched for using the current context on the context stack
and its annotated type information is used to convert all of the string parameters
passed in line to app... | [
"Invoke",
"a",
"function",
"given",
"a",
"list",
"of",
"arguments",
"with",
"the",
"function",
"listed",
"first",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L411-L468 | [
"def",
"invoke_one",
"(",
"self",
",",
"line",
")",
":",
"funname",
"=",
"line",
".",
"pop",
"(",
"0",
")",
"context",
"=",
"self",
".",
"contexts",
"[",
"-",
"1",
"]",
"func",
"=",
"self",
".",
"find_function",
"(",
"context",
",",
"funname",
")",... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell.invoke | Invoke a one or more function given a list of arguments.
The functions are searched for using the current context on the context stack
and its annotated type information is used to convert all of the string parameters
passed in line to appropriate python types.
Args:
line (... | typedargs/shell.py | def invoke(self, line):
"""Invoke a one or more function given a list of arguments.
The functions are searched for using the current context on the context stack
and its annotated type information is used to convert all of the string parameters
passed in line to appropriate python types... | def invoke(self, line):
"""Invoke a one or more function given a list of arguments.
The functions are searched for using the current context on the context stack
and its annotated type information is used to convert all of the string parameters
passed in line to appropriate python types... | [
"Invoke",
"a",
"one",
"or",
"more",
"function",
"given",
"a",
"list",
"of",
"arguments",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L470-L493 | [
"def",
"invoke",
"(",
"self",
",",
"line",
")",
":",
"finished",
"=",
"True",
"while",
"len",
"(",
"line",
")",
">",
"0",
":",
"val",
",",
"line",
",",
"finished",
"=",
"self",
".",
"invoke_one",
"(",
"line",
")",
"if",
"val",
"is",
"not",
"None"... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | HierarchicalShell.invoke_string | Parse and invoke a string line.
Args:
line (str): The line that we want to parse and invoke.
Returns:
bool: A boolean specifying if the last function created a new context
(False if a new context was created) and a list with the remainder of the
... | typedargs/shell.py | def invoke_string(self, line):
"""Parse and invoke a string line.
Args:
line (str): The line that we want to parse and invoke.
Returns:
bool: A boolean specifying if the last function created a new context
(False if a new context was created) and a list ... | def invoke_string(self, line):
"""Parse and invoke a string line.
Args:
line (str): The line that we want to parse and invoke.
Returns:
bool: A boolean specifying if the last function created a new context
(False if a new context was created) and a list ... | [
"Parse",
"and",
"invoke",
"a",
"string",
"line",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/shell.py#L495-L518 | [
"def",
"invoke_string",
"(",
"self",
",",
"line",
")",
":",
"# Make sure line is a unicode string on all python versions",
"line",
"=",
"str",
"(",
"line",
")",
"# Ignore empty lines and comments",
"if",
"len",
"(",
"line",
")",
"==",
"0",
":",
"return",
"True",
"... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | parse_param | Parse a single typed parameter statement. | typedargs/doc_parser.py | def parse_param(param, include_desc=False):
"""Parse a single typed parameter statement."""
param_def, _colon, desc = param.partition(':')
if not include_desc:
desc = None
else:
desc = desc.lstrip()
if _colon == "":
raise ValidationError("Invalid parameter declaration in do... | def parse_param(param, include_desc=False):
"""Parse a single typed parameter statement."""
param_def, _colon, desc = param.partition(':')
if not include_desc:
desc = None
else:
desc = desc.lstrip()
if _colon == "":
raise ValidationError("Invalid parameter declaration in do... | [
"Parse",
"a",
"single",
"typed",
"parameter",
"statement",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/doc_parser.py#L324-L341 | [
"def",
"parse_param",
"(",
"param",
",",
"include_desc",
"=",
"False",
")",
":",
"param_def",
",",
"_colon",
",",
"desc",
"=",
"param",
".",
"partition",
"(",
"':'",
")",
"if",
"not",
"include_desc",
":",
"desc",
"=",
"None",
"else",
":",
"desc",
"=",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | parse_return | Parse a single return statement declaration.
The valid types of return declarion are a Returns: section heading
followed a line that looks like:
type [format-as formatter]: description
OR
type [show-as (string | context)]: description sentence | typedargs/doc_parser.py | def parse_return(return_line, include_desc=False):
"""Parse a single return statement declaration.
The valid types of return declarion are a Returns: section heading
followed a line that looks like:
type [format-as formatter]: description
OR
type [show-as (string | context)]: description sent... | def parse_return(return_line, include_desc=False):
"""Parse a single return statement declaration.
The valid types of return declarion are a Returns: section heading
followed a line that looks like:
type [format-as formatter]: description
OR
type [show-as (string | context)]: description sent... | [
"Parse",
"a",
"single",
"return",
"statement",
"declaration",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/doc_parser.py#L344-L383 | [
"def",
"parse_return",
"(",
"return_line",
",",
"include_desc",
"=",
"False",
")",
":",
"ret_def",
",",
"_colon",
",",
"desc",
"=",
"return_line",
".",
"partition",
"(",
"':'",
")",
"if",
"_colon",
"==",
"\"\"",
":",
"raise",
"ValidationError",
"(",
"\"Inv... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | ParsedDocstring._classify_section | Attempt to find the canonical name of this section. | typedargs/doc_parser.py | def _classify_section(cls, section):
"""Attempt to find the canonical name of this section."""
name = section.lower()
if name in frozenset(['args', 'arguments', "params", "parameters"]):
return cls.ARGS_SECTION
if name in frozenset(['returns', 'return']):
retur... | def _classify_section(cls, section):
"""Attempt to find the canonical name of this section."""
name = section.lower()
if name in frozenset(['args', 'arguments', "params", "parameters"]):
return cls.ARGS_SECTION
if name in frozenset(['returns', 'return']):
retur... | [
"Attempt",
"to",
"find",
"the",
"canonical",
"name",
"of",
"this",
"section",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/doc_parser.py#L131-L145 | [
"def",
"_classify_section",
"(",
"cls",
",",
"section",
")",
":",
"name",
"=",
"section",
".",
"lower",
"(",
")",
"if",
"name",
"in",
"frozenset",
"(",
"[",
"'args'",
",",
"'arguments'",
",",
"\"params\"",
",",
"\"parameters\"",
"]",
")",
":",
"return",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | ParsedDocstring._classify_line | Classify a line into a type of object. | typedargs/doc_parser.py | def _classify_line(cls, line):
"""Classify a line into a type of object."""
line = line.rstrip()
if len(line) == 0:
return BlankLine('')
if ' ' not in line and line.endswith(':'):
name = line[:-1]
return SectionHeader(name)
if line.startswi... | def _classify_line(cls, line):
"""Classify a line into a type of object."""
line = line.rstrip()
if len(line) == 0:
return BlankLine('')
if ' ' not in line and line.endswith(':'):
name = line[:-1]
return SectionHeader(name)
if line.startswi... | [
"Classify",
"a",
"line",
"into",
"a",
"type",
"of",
"object",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/doc_parser.py#L148-L169 | [
"def",
"_classify_line",
"(",
"cls",
",",
"line",
")",
":",
"line",
"=",
"line",
".",
"rstrip",
"(",
")",
"if",
"len",
"(",
"line",
")",
"==",
"0",
":",
"return",
"BlankLine",
"(",
"''",
")",
"if",
"' '",
"not",
"in",
"line",
"and",
"line",
".",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | ParsedDocstring._join_paragraphs | Join adjacent lines together into paragraphs using either a blank line or indent as separator. | typedargs/doc_parser.py | def _join_paragraphs(cls, lines, use_indent=False, leading_blanks=False, trailing_blanks=False):
"""Join adjacent lines together into paragraphs using either a blank line or indent as separator."""
curr_para = []
paragraphs = []
for line in lines:
if use_indent:
... | def _join_paragraphs(cls, lines, use_indent=False, leading_blanks=False, trailing_blanks=False):
"""Join adjacent lines together into paragraphs using either a blank line or indent as separator."""
curr_para = []
paragraphs = []
for line in lines:
if use_indent:
... | [
"Join",
"adjacent",
"lines",
"together",
"into",
"paragraphs",
"using",
"either",
"a",
"blank",
"line",
"or",
"indent",
"as",
"separator",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/doc_parser.py#L240-L269 | [
"def",
"_join_paragraphs",
"(",
"cls",
",",
"lines",
",",
"use_indent",
"=",
"False",
",",
"leading_blanks",
"=",
"False",
",",
"trailing_blanks",
"=",
"False",
")",
":",
"curr_para",
"=",
"[",
"]",
"paragraphs",
"=",
"[",
"]",
"for",
"line",
"in",
"line... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | ParsedDocstring.wrap_and_format | Wrap, format and print this docstring for a specific width.
Args:
width (int): The number of characters per line. If set to None
this will be inferred from the terminal width and default
to 80 if not passed or if passed as None and the terminal
width... | typedargs/doc_parser.py | def wrap_and_format(self, width=None, include_params=False, include_return=False, excluded_params=None):
"""Wrap, format and print this docstring for a specific width.
Args:
width (int): The number of characters per line. If set to None
this will be inferred from the termin... | def wrap_and_format(self, width=None, include_params=False, include_return=False, excluded_params=None):
"""Wrap, format and print this docstring for a specific width.
Args:
width (int): The number of characters per line. If set to None
this will be inferred from the termin... | [
"Wrap",
"format",
"and",
"print",
"this",
"docstring",
"for",
"a",
"specific",
"width",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/doc_parser.py#L271-L321 | [
"def",
"wrap_and_format",
"(",
"self",
",",
"width",
"=",
"None",
",",
"include_params",
"=",
"False",
",",
"include_return",
"=",
"False",
",",
"excluded_params",
"=",
"None",
")",
":",
"if",
"excluded_params",
"is",
"None",
":",
"excluded_params",
"=",
"["... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.convert_to_type | Convert value to type 'typename'
If the conversion routine takes various kwargs to
modify the conversion process, \\**kwargs is passed
through to the underlying conversion function | typedargs/typeinfo.py | def convert_to_type(self, value, typename, **kwargs):
"""
Convert value to type 'typename'
If the conversion routine takes various kwargs to
modify the conversion process, \\**kwargs is passed
through to the underlying conversion function
"""
try:
if ... | def convert_to_type(self, value, typename, **kwargs):
"""
Convert value to type 'typename'
If the conversion routine takes various kwargs to
modify the conversion process, \\**kwargs is passed
through to the underlying conversion function
"""
try:
if ... | [
"Convert",
"value",
"to",
"type",
"typename"
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L76-L93 | [
"def",
"convert_to_type",
"(",
"self",
",",
"value",
",",
"typename",
",",
"*",
"*",
"kwargs",
")",
":",
"try",
":",
"if",
"isinstance",
"(",
"value",
",",
"bytearray",
")",
":",
"return",
"self",
".",
"convert_from_binary",
"(",
"value",
",",
"typename"... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.convert_from_binary | Convert binary data to type 'type'.
'type' must have a convert_binary function. If 'type'
supports size checking, the size function is called to ensure
that binvalue is the correct size for deserialization | typedargs/typeinfo.py | def convert_from_binary(self, binvalue, type, **kwargs):
"""
Convert binary data to type 'type'.
'type' must have a convert_binary function. If 'type'
supports size checking, the size function is called to ensure
that binvalue is the correct size for deserialization
"""... | def convert_from_binary(self, binvalue, type, **kwargs):
"""
Convert binary data to type 'type'.
'type' must have a convert_binary function. If 'type'
supports size checking, the size function is called to ensure
that binvalue is the correct size for deserialization
"""... | [
"Convert",
"binary",
"data",
"to",
"type",
"type",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L95-L113 | [
"def",
"convert_from_binary",
"(",
"self",
",",
"binvalue",
",",
"type",
",",
"*",
"*",
"kwargs",
")",
":",
"size",
"=",
"self",
".",
"get_type_size",
"(",
"type",
")",
"if",
"size",
">",
"0",
"and",
"len",
"(",
"binvalue",
")",
"!=",
"size",
":",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.get_type_size | Get the size of this type for converting a hex string to the
type. Return 0 if the size is not known. | typedargs/typeinfo.py | def get_type_size(self, type):
"""
Get the size of this type for converting a hex string to the
type. Return 0 if the size is not known.
"""
typeobj = self.get_type(type)
if hasattr(typeobj, 'size'):
return typeobj.size()
return 0 | def get_type_size(self, type):
"""
Get the size of this type for converting a hex string to the
type. Return 0 if the size is not known.
"""
typeobj = self.get_type(type)
if hasattr(typeobj, 'size'):
return typeobj.size()
return 0 | [
"Get",
"the",
"size",
"of",
"this",
"type",
"for",
"converting",
"a",
"hex",
"string",
"to",
"the",
"type",
".",
"Return",
"0",
"if",
"the",
"size",
"is",
"not",
"known",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L115-L126 | [
"def",
"get_type_size",
"(",
"self",
",",
"type",
")",
":",
"typeobj",
"=",
"self",
".",
"get_type",
"(",
"type",
")",
"if",
"hasattr",
"(",
"typeobj",
",",
"'size'",
")",
":",
"return",
"typeobj",
".",
"size",
"(",
")",
"return",
"0"
] | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.format_value | Convert value to type and format it as a string
type must be a known type in the type system and format,
if given, must specify a valid formatting option for the
specified type. | typedargs/typeinfo.py | def format_value(self, value, type, format=None, **kwargs):
"""
Convert value to type and format it as a string
type must be a known type in the type system and format,
if given, must specify a valid formatting option for the
specified type.
"""
typed_val = self... | def format_value(self, value, type, format=None, **kwargs):
"""
Convert value to type and format it as a string
type must be a known type in the type system and format,
if given, must specify a valid formatting option for the
specified type.
"""
typed_val = self... | [
"Convert",
"value",
"to",
"type",
"and",
"format",
"it",
"as",
"a",
"string"
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L128-L154 | [
"def",
"format_value",
"(",
"self",
",",
"value",
",",
"type",
",",
"format",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"typed_val",
"=",
"self",
".",
"convert_to_type",
"(",
"value",
",",
"type",
",",
"*",
"*",
"kwargs",
")",
"typeobj",
"=",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem._validate_type | Validate that all required type methods are implemented.
At minimum a type must have:
- a convert() or convert_binary() function
- a default_formatter() function
Raises an ArgumentError if the type is not valid | typedargs/typeinfo.py | def _validate_type(cls, typeobj):
"""
Validate that all required type methods are implemented.
At minimum a type must have:
- a convert() or convert_binary() function
- a default_formatter() function
Raises an ArgumentError if the type is not valid
"""
... | def _validate_type(cls, typeobj):
"""
Validate that all required type methods are implemented.
At minimum a type must have:
- a convert() or convert_binary() function
- a default_formatter() function
Raises an ArgumentError if the type is not valid
"""
... | [
"Validate",
"that",
"all",
"required",
"type",
"methods",
"are",
"implemented",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L157-L172 | [
"def",
"_validate_type",
"(",
"cls",
",",
"typeobj",
")",
":",
"if",
"not",
"(",
"hasattr",
"(",
"typeobj",
",",
"\"convert\"",
")",
"or",
"hasattr",
"(",
"typeobj",
",",
"\"convert_binary\"",
")",
")",
":",
"raise",
"ArgumentError",
"(",
"\"type is invalid,... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.is_known_type | Check if type is known to the type system.
Returns:
bool: True if the type is a known instantiated simple type, False otherwise | typedargs/typeinfo.py | def is_known_type(self, type_name):
"""Check if type is known to the type system.
Returns:
bool: True if the type is a known instantiated simple type, False otherwise
"""
type_name = str(type_name)
if type_name in self.known_types:
return True
r... | def is_known_type(self, type_name):
"""Check if type is known to the type system.
Returns:
bool: True if the type is a known instantiated simple type, False otherwise
"""
type_name = str(type_name)
if type_name in self.known_types:
return True
r... | [
"Check",
"if",
"type",
"is",
"known",
"to",
"the",
"type",
"system",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L174-L185 | [
"def",
"is_known_type",
"(",
"self",
",",
"type_name",
")",
":",
"type_name",
"=",
"str",
"(",
"type_name",
")",
"if",
"type_name",
"in",
"self",
".",
"known_types",
":",
"return",
"True",
"return",
"False"
] | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.split_type | Given a potentially complex type, split it into its base type and specializers | typedargs/typeinfo.py | def split_type(self, typename):
"""
Given a potentially complex type, split it into its base type and specializers
"""
name = self._canonicalize_type(typename)
if '(' not in name:
return name, False, []
base, sub = name.split('(')
if len(sub) == 0 or... | def split_type(self, typename):
"""
Given a potentially complex type, split it into its base type and specializers
"""
name = self._canonicalize_type(typename)
if '(' not in name:
return name, False, []
base, sub = name.split('(')
if len(sub) == 0 or... | [
"Given",
"a",
"potentially",
"complex",
"type",
"split",
"it",
"into",
"its",
"base",
"type",
"and",
"specializers"
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L187-L203 | [
"def",
"split_type",
"(",
"self",
",",
"typename",
")",
":",
"name",
"=",
"self",
".",
"_canonicalize_type",
"(",
"typename",
")",
"if",
"'('",
"not",
"in",
"name",
":",
"return",
"name",
",",
"False",
",",
"[",
"]",
"base",
",",
"sub",
"=",
"name",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.instantiate_type | Instantiate a complex type. | typedargs/typeinfo.py | def instantiate_type(self, typename, base, subtypes):
"""Instantiate a complex type."""
if base not in self.type_factories:
raise ArgumentError("unknown complex base type specified", passed_type=typename, base_type=base)
base_type = self.type_factories[base]
#Make sure all... | def instantiate_type(self, typename, base, subtypes):
"""Instantiate a complex type."""
if base not in self.type_factories:
raise ArgumentError("unknown complex base type specified", passed_type=typename, base_type=base)
base_type = self.type_factories[base]
#Make sure all... | [
"Instantiate",
"a",
"complex",
"type",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L205-L221 | [
"def",
"instantiate_type",
"(",
"self",
",",
"typename",
",",
"base",
",",
"subtypes",
")",
":",
"if",
"base",
"not",
"in",
"self",
".",
"type_factories",
":",
"raise",
"ArgumentError",
"(",
"\"unknown complex base type specified\"",
",",
"passed_type",
"=",
"ty... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.get_type | Return the type object corresponding to a type name.
If type_name is not found, this triggers the loading of
external types until a matching type is found or until there
are no more external type sources. | typedargs/typeinfo.py | def get_type(self, type_name):
"""Return the type object corresponding to a type name.
If type_name is not found, this triggers the loading of
external types until a matching type is found or until there
are no more external type sources.
"""
type_name = self._canonical... | def get_type(self, type_name):
"""Return the type object corresponding to a type name.
If type_name is not found, this triggers the loading of
external types until a matching type is found or until there
are no more external type sources.
"""
type_name = self._canonical... | [
"Return",
"the",
"type",
"object",
"corresponding",
"to",
"a",
"type",
"name",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L238-L296 | [
"def",
"get_type",
"(",
"self",
",",
"type_name",
")",
":",
"type_name",
"=",
"self",
".",
"_canonicalize_type",
"(",
"type_name",
")",
"# Add basic transformations on common abbreviations",
"if",
"str",
"(",
"type_name",
")",
"==",
"'int'",
":",
"type_name",
"=",... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.is_known_format | Check if format is known for given type.
Returns boolean indicating if format is valid for the specified type. | typedargs/typeinfo.py | def is_known_format(self, type, format):
"""
Check if format is known for given type.
Returns boolean indicating if format is valid for the specified type.
"""
typeobj = self.get_type(type)
formatter = "format_%s" % str(format)
if not hasattr(typeobj, formatter... | def is_known_format(self, type, format):
"""
Check if format is known for given type.
Returns boolean indicating if format is valid for the specified type.
"""
typeobj = self.get_type(type)
formatter = "format_%s" % str(format)
if not hasattr(typeobj, formatter... | [
"Check",
"if",
"format",
"is",
"known",
"for",
"given",
"type",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L298-L311 | [
"def",
"is_known_format",
"(",
"self",
",",
"type",
",",
"format",
")",
":",
"typeobj",
"=",
"self",
".",
"get_type",
"(",
"type",
")",
"formatter",
"=",
"\"format_%s\"",
"%",
"str",
"(",
"format",
")",
"if",
"not",
"hasattr",
"(",
"typeobj",
",",
"for... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.inject_type | Given a module-like object that defines a type, add it to our type system so that
it can be used with the iotile tool and with other annotated API functions. | typedargs/typeinfo.py | def inject_type(self, name, typeobj):
"""
Given a module-like object that defines a type, add it to our type system so that
it can be used with the iotile tool and with other annotated API functions.
"""
name = self._canonicalize_type(name)
_, is_complex, _ = self.split_... | def inject_type(self, name, typeobj):
"""
Given a module-like object that defines a type, add it to our type system so that
it can be used with the iotile tool and with other annotated API functions.
"""
name = self._canonicalize_type(name)
_, is_complex, _ = self.split_... | [
"Given",
"a",
"module",
"-",
"like",
"object",
"that",
"defines",
"a",
"type",
"add",
"it",
"to",
"our",
"type",
"system",
"so",
"that",
"it",
"can",
"be",
"used",
"with",
"the",
"iotile",
"tool",
"and",
"with",
"other",
"annotated",
"API",
"functions",
... | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L313-L334 | [
"def",
"inject_type",
"(",
"self",
",",
"name",
",",
"typeobj",
")",
":",
"name",
"=",
"self",
".",
"_canonicalize_type",
"(",
"name",
")",
"_",
",",
"is_complex",
",",
"_",
"=",
"self",
".",
"split_type",
"(",
"name",
")",
"if",
"self",
".",
"is_kno... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.load_type_module | Given a module that contains a list of some types find all symbols in the module that
do not start with _ and attempt to import them as types. | typedargs/typeinfo.py | def load_type_module(self, module):
"""
Given a module that contains a list of some types find all symbols in the module that
do not start with _ and attempt to import them as types.
"""
for name in (x for x in dir(module) if not x.startswith('_')):
typeobj = getattr... | def load_type_module(self, module):
"""
Given a module that contains a list of some types find all symbols in the module that
do not start with _ and attempt to import them as types.
"""
for name in (x for x in dir(module) if not x.startswith('_')):
typeobj = getattr... | [
"Given",
"a",
"module",
"that",
"contains",
"a",
"list",
"of",
"some",
"types",
"find",
"all",
"symbols",
"in",
"the",
"module",
"that",
"do",
"not",
"start",
"with",
"_",
"and",
"attempt",
"to",
"import",
"them",
"as",
"types",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L336-L348 | [
"def",
"load_type_module",
"(",
"self",
",",
"module",
")",
":",
"for",
"name",
"in",
"(",
"x",
"for",
"x",
"in",
"dir",
"(",
"module",
")",
"if",
"not",
"x",
".",
"startswith",
"(",
"'_'",
")",
")",
":",
"typeobj",
"=",
"getattr",
"(",
"module",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | TypeSystem.load_external_types | Given a path to a python package or module, load that module, search for all defined variables
inside of it that do not start with _ or __ and inject them into the type system. If any of the
types cannot be injected, silently ignore them unless verbose is True. If path points to a module
it sh... | typedargs/typeinfo.py | def load_external_types(self, path):
"""
Given a path to a python package or module, load that module, search for all defined variables
inside of it that do not start with _ or __ and inject them into the type system. If any of the
types cannot be injected, silently ignore them unless v... | def load_external_types(self, path):
"""
Given a path to a python package or module, load that module, search for all defined variables
inside of it that do not start with _ or __ and inject them into the type system. If any of the
types cannot be injected, silently ignore them unless v... | [
"Given",
"a",
"path",
"to",
"a",
"python",
"package",
"or",
"module",
"load",
"that",
"module",
"search",
"for",
"all",
"defined",
"variables",
"inside",
"of",
"it",
"that",
"do",
"not",
"start",
"with",
"_",
"or",
"__",
"and",
"inject",
"them",
"into",
... | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/typeinfo.py#L350-L366 | [
"def",
"load_external_types",
"(",
"self",
",",
"path",
")",
":",
"folder",
",",
"filename",
"=",
"os",
".",
"path",
".",
"split",
"(",
"path",
")",
"try",
":",
"fileobj",
",",
"pathname",
",",
"description",
"=",
"imp",
".",
"find_module",
"(",
"filen... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | AnnotatedMetadata.spec_filled | Check if we have enough arguments to call this function.
Args:
pos_args (list): A list of all the positional values we have.
kw_args (dict): A dict of all of the keyword args we have.
Returns:
bool: True if we have a filled spec, False otherwise. | typedargs/metadata.py | def spec_filled(self, pos_args, kw_args):
"""Check if we have enough arguments to call this function.
Args:
pos_args (list): A list of all the positional values we have.
kw_args (dict): A dict of all of the keyword args we have.
Returns:
bool: True if we hav... | def spec_filled(self, pos_args, kw_args):
"""Check if we have enough arguments to call this function.
Args:
pos_args (list): A list of all the positional values we have.
kw_args (dict): A dict of all of the keyword args we have.
Returns:
bool: True if we hav... | [
"Check",
"if",
"we",
"have",
"enough",
"arguments",
"to",
"call",
"this",
"function",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/metadata.py#L91-L107 | [
"def",
"spec_filled",
"(",
"self",
",",
"pos_args",
",",
"kw_args",
")",
":",
"req_names",
"=",
"self",
".",
"arg_names",
"if",
"len",
"(",
"self",
".",
"arg_defaults",
")",
">",
"0",
":",
"req_names",
"=",
"req_names",
"[",
":",
"-",
"len",
"(",
"se... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | AnnotatedMetadata.add_param | Add type information for a parameter by name.
Args:
name (str): The name of the parameter we wish to annotate
type_name (str): The name of the parameter's type
validators (list): A list of either strings or n tuples that each
specify a validator defined for t... | typedargs/metadata.py | def add_param(self, name, type_name, validators, desc=None):
"""Add type information for a parameter by name.
Args:
name (str): The name of the parameter we wish to annotate
type_name (str): The name of the parameter's type
validators (list): A list of either strings... | def add_param(self, name, type_name, validators, desc=None):
"""Add type information for a parameter by name.
Args:
name (str): The name of the parameter we wish to annotate
type_name (str): The name of the parameter's type
validators (list): A list of either strings... | [
"Add",
"type",
"information",
"for",
"a",
"parameter",
"by",
"name",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/metadata.py#L109-L129 | [
"def",
"add_param",
"(",
"self",
",",
"name",
",",
"type_name",
",",
"validators",
",",
"desc",
"=",
"None",
")",
":",
"if",
"name",
"in",
"self",
".",
"annotated_params",
":",
"raise",
"TypeSystemError",
"(",
"\"Annotation specified multiple times for the same pa... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | AnnotatedMetadata.typed_returnvalue | Add type information to the return value of this function.
Args:
type_name (str): The name of the type of the return value.
formatter (str): An optional name of a formatting function specified
for the type given in type_name. | typedargs/metadata.py | def typed_returnvalue(self, type_name, formatter=None):
"""Add type information to the return value of this function.
Args:
type_name (str): The name of the type of the return value.
formatter (str): An optional name of a formatting function specified
for the typ... | def typed_returnvalue(self, type_name, formatter=None):
"""Add type information to the return value of this function.
Args:
type_name (str): The name of the type of the return value.
formatter (str): An optional name of a formatting function specified
for the typ... | [
"Add",
"type",
"information",
"to",
"the",
"return",
"value",
"of",
"this",
"function",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/metadata.py#L131-L139 | [
"def",
"typed_returnvalue",
"(",
"self",
",",
"type_name",
",",
"formatter",
"=",
"None",
")",
":",
"self",
".",
"return_info",
"=",
"ReturnInfo",
"(",
"type_name",
",",
"formatter",
",",
"True",
",",
"None",
")"
] | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | AnnotatedMetadata.custom_returnvalue | Use a custom function to print the return value.
Args:
printer (callable): A function that should take in the return
value and convert it to a string.
desc (str): An optional description of the return value. | typedargs/metadata.py | def custom_returnvalue(self, printer, desc=None):
"""Use a custom function to print the return value.
Args:
printer (callable): A function that should take in the return
value and convert it to a string.
desc (str): An optional description of the return value.
... | def custom_returnvalue(self, printer, desc=None):
"""Use a custom function to print the return value.
Args:
printer (callable): A function that should take in the return
value and convert it to a string.
desc (str): An optional description of the return value.
... | [
"Use",
"a",
"custom",
"function",
"to",
"print",
"the",
"return",
"value",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/metadata.py#L145-L153 | [
"def",
"custom_returnvalue",
"(",
"self",
",",
"printer",
",",
"desc",
"=",
"None",
")",
":",
"self",
".",
"return_info",
"=",
"ReturnInfo",
"(",
"None",
",",
"printer",
",",
"True",
",",
"desc",
")"
] | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | AnnotatedMetadata.match_shortname | Try to convert a prefix into a parameter name.
If the result could be ambiguous or there is no matching
parameter, throw an ArgumentError
Args:
name (str): A prefix for a parameter name
filled_args (list): A list of filled positional arguments that will be
... | typedargs/metadata.py | def match_shortname(self, name, filled_args=None):
"""Try to convert a prefix into a parameter name.
If the result could be ambiguous or there is no matching
parameter, throw an ArgumentError
Args:
name (str): A prefix for a parameter name
filled_args (list): A ... | def match_shortname(self, name, filled_args=None):
"""Try to convert a prefix into a parameter name.
If the result could be ambiguous or there is no matching
parameter, throw an ArgumentError
Args:
name (str): A prefix for a parameter name
filled_args (list): A ... | [
"Try",
"to",
"convert",
"a",
"prefix",
"into",
"a",
"parameter",
"name",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/metadata.py#L170-L195 | [
"def",
"match_shortname",
"(",
"self",
",",
"name",
",",
"filled_args",
"=",
"None",
")",
":",
"filled_count",
"=",
"0",
"if",
"filled_args",
"is",
"not",
"None",
":",
"filled_count",
"=",
"len",
"(",
"filled_args",
")",
"possible",
"=",
"[",
"x",
"for",... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | AnnotatedMetadata.param_type | Get the parameter type information by name.
Args:
name (str): The full name of a parameter.
Returns:
str: The type name or None if no type information is given. | typedargs/metadata.py | def param_type(self, name):
"""Get the parameter type information by name.
Args:
name (str): The full name of a parameter.
Returns:
str: The type name or None if no type information is given.
"""
self._ensure_loaded()
if name not in self.annota... | def param_type(self, name):
"""Get the parameter type information by name.
Args:
name (str): The full name of a parameter.
Returns:
str: The type name or None if no type information is given.
"""
self._ensure_loaded()
if name not in self.annota... | [
"Get",
"the",
"parameter",
"type",
"information",
"by",
"name",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/metadata.py#L197-L212 | [
"def",
"param_type",
"(",
"self",
",",
"name",
")",
":",
"self",
".",
"_ensure_loaded",
"(",
")",
"if",
"name",
"not",
"in",
"self",
".",
"annotated_params",
":",
"return",
"None",
"return",
"self",
".",
"annotated_params",
"[",
"name",
"]",
".",
"type_n... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | AnnotatedMetadata.signature | Return our function signature as a string.
By default this function uses the annotated name of the function
however if you need to override that with a custom name you can
pass name=<custom name>
Args:
name (str): Optional name to override the default name given
... | typedargs/metadata.py | def signature(self, name=None):
"""Return our function signature as a string.
By default this function uses the annotated name of the function
however if you need to override that with a custom name you can
pass name=<custom name>
Args:
name (str): Optional name to ... | def signature(self, name=None):
"""Return our function signature as a string.
By default this function uses the annotated name of the function
however if you need to override that with a custom name you can
pass name=<custom name>
Args:
name (str): Optional name to ... | [
"Return",
"our",
"function",
"signature",
"as",
"a",
"string",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/metadata.py#L214-L258 | [
"def",
"signature",
"(",
"self",
",",
"name",
"=",
"None",
")",
":",
"self",
".",
"_ensure_loaded",
"(",
")",
"if",
"name",
"is",
"None",
":",
"name",
"=",
"self",
".",
"name",
"num_args",
"=",
"len",
"(",
"self",
".",
"arg_names",
")",
"num_def",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | AnnotatedMetadata.format_returnvalue | Format the return value of this function as a string.
Args:
value (object): The return value that we are supposed to format.
Returns:
str: The formatted return value, or None if this function indicates
that it does not return data | typedargs/metadata.py | def format_returnvalue(self, value):
"""Format the return value of this function as a string.
Args:
value (object): The return value that we are supposed to format.
Returns:
str: The formatted return value, or None if this function indicates
that it does... | def format_returnvalue(self, value):
"""Format the return value of this function as a string.
Args:
value (object): The return value that we are supposed to format.
Returns:
str: The formatted return value, or None if this function indicates
that it does... | [
"Format",
"the",
"return",
"value",
"of",
"this",
"function",
"as",
"a",
"string",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/metadata.py#L260-L281 | [
"def",
"format_returnvalue",
"(",
"self",
",",
"value",
")",
":",
"self",
".",
"_ensure_loaded",
"(",
")",
"if",
"not",
"self",
".",
"return_info",
".",
"is_data",
":",
"return",
"None",
"# If the return value is typed, use the type_system to format it",
"if",
"self... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | AnnotatedMetadata.convert_positional_argument | Convert and validate a positional argument.
Args:
index (int): The positional index of the argument
arg_value (object): The value to convert and validate
Returns:
object: The converted value. | typedargs/metadata.py | def convert_positional_argument(self, index, arg_value):
"""Convert and validate a positional argument.
Args:
index (int): The positional index of the argument
arg_value (object): The value to convert and validate
Returns:
object: The converted value.
... | def convert_positional_argument(self, index, arg_value):
"""Convert and validate a positional argument.
Args:
index (int): The positional index of the argument
arg_value (object): The value to convert and validate
Returns:
object: The converted value.
... | [
"Convert",
"and",
"validate",
"a",
"positional",
"argument",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/metadata.py#L283-L302 | [
"def",
"convert_positional_argument",
"(",
"self",
",",
"index",
",",
"arg_value",
")",
":",
"# For bound methods, skip self",
"if",
"self",
".",
"_has_self",
":",
"if",
"index",
"==",
"0",
":",
"return",
"arg_value",
"index",
"-=",
"1",
"arg_name",
"=",
"self... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | AnnotatedMetadata.check_spec | Check if there are any missing or duplicate arguments.
Args:
pos_args (list): A list of arguments that will be passed as positional
arguments.
kwargs (dict): A dictionary of the keyword arguments that will be passed.
Returns:
dict: A dictionary of ar... | typedargs/metadata.py | def check_spec(self, pos_args, kwargs=None):
"""Check if there are any missing or duplicate arguments.
Args:
pos_args (list): A list of arguments that will be passed as positional
arguments.
kwargs (dict): A dictionary of the keyword arguments that will be passed... | def check_spec(self, pos_args, kwargs=None):
"""Check if there are any missing or duplicate arguments.
Args:
pos_args (list): A list of arguments that will be passed as positional
arguments.
kwargs (dict): A dictionary of the keyword arguments that will be passed... | [
"Check",
"if",
"there",
"are",
"any",
"missing",
"or",
"duplicate",
"arguments",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/metadata.py#L304-L360 | [
"def",
"check_spec",
"(",
"self",
",",
"pos_args",
",",
"kwargs",
"=",
"None",
")",
":",
"if",
"kwargs",
"is",
"None",
":",
"kwargs",
"=",
"{",
"}",
"if",
"self",
".",
"varargs",
"is",
"not",
"None",
"or",
"self",
".",
"kwargs",
"is",
"not",
"None"... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | AnnotatedMetadata.convert_argument | Given a parameter with type information, convert and validate it.
Args:
arg_name (str): The name of the argument to convert and validate
arg_value (object): The value to convert and validate
Returns:
object: The converted value. | typedargs/metadata.py | def convert_argument(self, arg_name, arg_value):
"""Given a parameter with type information, convert and validate it.
Args:
arg_name (str): The name of the argument to convert and validate
arg_value (object): The value to convert and validate
Returns:
object... | def convert_argument(self, arg_name, arg_value):
"""Given a parameter with type information, convert and validate it.
Args:
arg_name (str): The name of the argument to convert and validate
arg_value (object): The value to convert and validate
Returns:
object... | [
"Given",
"a",
"parameter",
"with",
"type",
"information",
"convert",
"and",
"validate",
"it",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/metadata.py#L362-L400 | [
"def",
"convert_argument",
"(",
"self",
",",
"arg_name",
",",
"arg_value",
")",
":",
"self",
".",
"_ensure_loaded",
"(",
")",
"type_name",
"=",
"self",
".",
"param_type",
"(",
"arg_name",
")",
"if",
"type_name",
"is",
"None",
":",
"return",
"arg_value",
"v... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | KeyValueException.format | Format this exception as a string including class name.
Args:
exclude_class (bool): Whether to exclude the exception class
name when formatting this exception
Returns:
string: a multiline string with the message, class name and
key value paramete... | typedargs/exceptions.py | def format(self, exclude_class=False):
"""Format this exception as a string including class name.
Args:
exclude_class (bool): Whether to exclude the exception class
name when formatting this exception
Returns:
string: a multiline string with the message,... | def format(self, exclude_class=False):
"""Format this exception as a string including class name.
Args:
exclude_class (bool): Whether to exclude the exception class
name when formatting this exception
Returns:
string: a multiline string with the message,... | [
"Format",
"this",
"exception",
"as",
"a",
"string",
"including",
"class",
"name",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/exceptions.py#L31-L52 | [
"def",
"format",
"(",
"self",
",",
"exclude_class",
"=",
"False",
")",
":",
"if",
"exclude_class",
":",
"msg",
"=",
"self",
".",
"msg",
"else",
":",
"msg",
"=",
"\"%s: %s\"",
"%",
"(",
"self",
".",
"__class__",
".",
"__name__",
",",
"self",
".",
"msg... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | KeyValueException.to_dict | Convert this exception to a dictionary.
Returns:
dist: A dictionary of information about this exception,
Has a 'reason' key, a 'type' key and a dictionary of params | typedargs/exceptions.py | def to_dict(self):
"""Convert this exception to a dictionary.
Returns:
dist: A dictionary of information about this exception,
Has a 'reason' key, a 'type' key and a dictionary of params
"""
out = {}
out['reason'] = self.msg
out['type'] = se... | def to_dict(self):
"""Convert this exception to a dictionary.
Returns:
dist: A dictionary of information about this exception,
Has a 'reason' key, a 'type' key and a dictionary of params
"""
out = {}
out['reason'] = self.msg
out['type'] = se... | [
"Convert",
"this",
"exception",
"to",
"a",
"dictionary",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/exceptions.py#L64-L77 | [
"def",
"to_dict",
"(",
"self",
")",
":",
"out",
"=",
"{",
"}",
"out",
"[",
"'reason'",
"]",
"=",
"self",
".",
"msg",
"out",
"[",
"'type'",
"]",
"=",
"self",
".",
"__class__",
".",
"__name__",
"out",
"[",
"'params'",
"]",
"=",
"self",
".",
"params... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | _check_and_execute | Check the type of all parameters with type information, converting
as appropriate and then execute the function. | typedargs/utils.py | def _check_and_execute(func, *args, **kwargs):
"""
Check the type of all parameters with type information, converting
as appropriate and then execute the function.
"""
convargs = []
#Convert and validate all arguments
for i, arg in enumerate(args):
val = func.metadata.convert_posit... | def _check_and_execute(func, *args, **kwargs):
"""
Check the type of all parameters with type information, converting
as appropriate and then execute the function.
"""
convargs = []
#Convert and validate all arguments
for i, arg in enumerate(args):
val = func.metadata.convert_posit... | [
"Check",
"the",
"type",
"of",
"all",
"parameters",
"with",
"type",
"information",
"converting",
"as",
"appropriate",
"and",
"then",
"execute",
"the",
"function",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/utils.py#L12-L33 | [
"def",
"_check_and_execute",
"(",
"func",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"convargs",
"=",
"[",
"]",
"#Convert and validate all arguments",
"for",
"i",
",",
"arg",
"in",
"enumerate",
"(",
"args",
")",
":",
"val",
"=",
"func",
".",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | _parse_validators | Parse a list of validator names or n-tuples, checking for errors.
Returns:
list((func_name, [args...])): A list of validator function names and a
potentially empty list of optional parameters for each function. | typedargs/utils.py | def _parse_validators(valids):
"""Parse a list of validator names or n-tuples, checking for errors.
Returns:
list((func_name, [args...])): A list of validator function names and a
potentially empty list of optional parameters for each function.
"""
outvals = []
for val in vali... | def _parse_validators(valids):
"""Parse a list of validator names or n-tuples, checking for errors.
Returns:
list((func_name, [args...])): A list of validator function names and a
potentially empty list of optional parameters for each function.
"""
outvals = []
for val in vali... | [
"Parse",
"a",
"list",
"of",
"validator",
"names",
"or",
"n",
"-",
"tuples",
"checking",
"for",
"errors",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/utils.py#L36-L58 | [
"def",
"_parse_validators",
"(",
"valids",
")",
":",
"outvals",
"=",
"[",
"]",
"for",
"val",
"in",
"valids",
":",
"if",
"isinstance",
"(",
"val",
",",
"str",
")",
":",
"args",
"=",
"[",
"]",
"elif",
"len",
"(",
"val",
")",
">",
"1",
":",
"args",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | find_all | Find all annotated function inside of a container.
Annotated functions are identified as those that:
- do not start with a _ character
- are either annotated with metadata
- or strings that point to lazily loaded modules
Args:
container (object): The container to search for annotated funct... | typedargs/utils.py | def find_all(container):
"""Find all annotated function inside of a container.
Annotated functions are identified as those that:
- do not start with a _ character
- are either annotated with metadata
- or strings that point to lazily loaded modules
Args:
container (object): The contain... | def find_all(container):
"""Find all annotated function inside of a container.
Annotated functions are identified as those that:
- do not start with a _ character
- are either annotated with metadata
- or strings that point to lazily loaded modules
Args:
container (object): The contain... | [
"Find",
"all",
"annotated",
"function",
"inside",
"of",
"a",
"container",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/utils.py#L69-L111 | [
"def",
"find_all",
"(",
"container",
")",
":",
"if",
"isinstance",
"(",
"container",
",",
"dict",
")",
":",
"names",
"=",
"container",
".",
"keys",
"(",
")",
"else",
":",
"names",
"=",
"dir",
"(",
"container",
")",
"built_context",
"=",
"BasicContext",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | context_from_module | Given a module, create a context from all of the top level annotated
symbols in that module. | typedargs/annotate.py | def context_from_module(module):
"""
Given a module, create a context from all of the top level annotated
symbols in that module.
"""
con = find_all(module)
if hasattr(module, "__doc__"):
setattr(con, "__doc__", module.__doc__)
name = module.__name__
if hasattr(module, "_name_... | def context_from_module(module):
"""
Given a module, create a context from all of the top level annotated
symbols in that module.
"""
con = find_all(module)
if hasattr(module, "__doc__"):
setattr(con, "__doc__", module.__doc__)
name = module.__name__
if hasattr(module, "_name_... | [
"Given",
"a",
"module",
"create",
"a",
"context",
"from",
"all",
"of",
"the",
"top",
"level",
"annotated",
"symbols",
"in",
"that",
"module",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/annotate.py#L19-L37 | [
"def",
"context_from_module",
"(",
"module",
")",
":",
"con",
"=",
"find_all",
"(",
"module",
")",
"if",
"hasattr",
"(",
"module",
",",
"\"__doc__\"",
")",
":",
"setattr",
"(",
"con",
",",
"\"__doc__\"",
",",
"module",
".",
"__doc__",
")",
"name",
"=",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | get_help | Return usage information about a context or function.
For contexts, just return the context name and its docstring
For functions, return the function signature as well as its
argument types.
Args:
func (callable): An annotated callable function
Returns:
str: The formatted help tex... | typedargs/annotate.py | def get_help(func):
"""Return usage information about a context or function.
For contexts, just return the context name and its docstring
For functions, return the function signature as well as its
argument types.
Args:
func (callable): An annotated callable function
Returns:
... | def get_help(func):
"""Return usage information about a context or function.
For contexts, just return the context name and its docstring
For functions, return the function signature as well as its
argument types.
Args:
func (callable): An annotated callable function
Returns:
... | [
"Return",
"usage",
"information",
"about",
"a",
"context",
"or",
"function",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/annotate.py#L40-L93 | [
"def",
"get_help",
"(",
"func",
")",
":",
"help_text",
"=",
"\"\"",
"if",
"isinstance",
"(",
"func",
",",
"dict",
")",
":",
"name",
"=",
"context_name",
"(",
"func",
")",
"help_text",
"=",
"\"\\n\"",
"+",
"name",
"+",
"\"\\n\\n\"",
"doc",
"=",
"inspect... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | param | Decorate a function to give type information about its parameters.
This function stores a type name, optional description and optional list
of validation functions along with the decorated function it is called
on in order to allow run time type conversions and validation.
Args:
name (string):... | typedargs/annotate.py | def param(name, type_name, *validators, **kwargs):
"""Decorate a function to give type information about its parameters.
This function stores a type name, optional description and optional list
of validation functions along with the decorated function it is called
on in order to allow run time type con... | def param(name, type_name, *validators, **kwargs):
"""Decorate a function to give type information about its parameters.
This function stores a type name, optional description and optional list
of validation functions along with the decorated function it is called
on in order to allow run time type con... | [
"Decorate",
"a",
"function",
"to",
"give",
"type",
"information",
"about",
"its",
"parameters",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/annotate.py#L98-L139 | [
"def",
"param",
"(",
"name",
",",
"type_name",
",",
"*",
"validators",
",",
"*",
"*",
"kwargs",
")",
":",
"def",
"_param",
"(",
"func",
")",
":",
"func",
"=",
"annotated",
"(",
"func",
")",
"valids",
"=",
"_parse_validators",
"(",
"validators",
")",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | returns | Specify how the return value of this function should be handled.
Args:
desc (str): A deprecated description of the return value
printer (callable): A callable function that can format this return value
data (bool): A deprecated parameter for specifying that this function
returns... | typedargs/annotate.py | def returns(desc=None, printer=None, data=True):
"""Specify how the return value of this function should be handled.
Args:
desc (str): A deprecated description of the return value
printer (callable): A callable function that can format this return value
data (bool): A deprecated paramet... | def returns(desc=None, printer=None, data=True):
"""Specify how the return value of this function should be handled.
Args:
desc (str): A deprecated description of the return value
printer (callable): A callable function that can format this return value
data (bool): A deprecated paramet... | [
"Specify",
"how",
"the",
"return",
"value",
"of",
"this",
"function",
"should",
"be",
"handled",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/annotate.py#L142-L160 | [
"def",
"returns",
"(",
"desc",
"=",
"None",
",",
"printer",
"=",
"None",
",",
"data",
"=",
"True",
")",
":",
"if",
"data",
"is",
"False",
":",
"raise",
"ArgumentError",
"(",
"\"Specifying non data return type in returns is no longer supported\"",
")",
"def",
"_r... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | return_type | Specify that this function returns a typed value.
Args:
type_name (str): A type name known to the global typedargs type system
formatter (str): An optional name of a formatting function specified
for the type given in type_name. | typedargs/annotate.py | def return_type(type_name, formatter=None):
"""Specify that this function returns a typed value.
Args:
type_name (str): A type name known to the global typedargs type system
formatter (str): An optional name of a formatting function specified
for the type given in type_name.
"""... | def return_type(type_name, formatter=None):
"""Specify that this function returns a typed value.
Args:
type_name (str): A type name known to the global typedargs type system
formatter (str): An optional name of a formatting function specified
for the type given in type_name.
"""... | [
"Specify",
"that",
"this",
"function",
"returns",
"a",
"typed",
"value",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/annotate.py#L175-L189 | [
"def",
"return_type",
"(",
"type_name",
",",
"formatter",
"=",
"None",
")",
":",
"def",
"_returns",
"(",
"func",
")",
":",
"annotated",
"(",
"func",
")",
"func",
".",
"metadata",
".",
"typed_returnvalue",
"(",
"type_name",
",",
"formatter",
")",
"return",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | context | Declare that a class defines a context.
Contexts are for use with HierarchicalShell for discovering
and using functionality from the command line.
Args:
name (str): Optional name for this context if you don't want
to just use the class name. | typedargs/annotate.py | def context(name=None):
"""Declare that a class defines a context.
Contexts are for use with HierarchicalShell for discovering
and using functionality from the command line.
Args:
name (str): Optional name for this context if you don't want
to just use the class name.
"""
... | def context(name=None):
"""Declare that a class defines a context.
Contexts are for use with HierarchicalShell for discovering
and using functionality from the command line.
Args:
name (str): Optional name for this context if you don't want
to just use the class name.
"""
... | [
"Declare",
"that",
"a",
"class",
"defines",
"a",
"context",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/annotate.py#L192-L209 | [
"def",
"context",
"(",
"name",
"=",
"None",
")",
":",
"def",
"_context",
"(",
"cls",
")",
":",
"annotated",
"(",
"cls",
",",
"name",
")",
"cls",
".",
"context",
"=",
"True",
"return",
"cls",
"return",
"_context"
] | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | docannotate | Annotate a function using information from its docstring.
The annotation actually happens at the time the function is first called
to improve startup time. For this function to work, the docstring must be
formatted correctly. You should use the typedargs pylint plugin to make
sure there are no errors... | typedargs/annotate.py | def docannotate(func):
"""Annotate a function using information from its docstring.
The annotation actually happens at the time the function is first called
to improve startup time. For this function to work, the docstring must be
formatted correctly. You should use the typedargs pylint plugin to mak... | def docannotate(func):
"""Annotate a function using information from its docstring.
The annotation actually happens at the time the function is first called
to improve startup time. For this function to work, the docstring must be
formatted correctly. You should use the typedargs pylint plugin to mak... | [
"Annotate",
"a",
"function",
"using",
"information",
"from",
"its",
"docstring",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/annotate.py#L231-L247 | [
"def",
"docannotate",
"(",
"func",
")",
":",
"func",
"=",
"annotated",
"(",
"func",
")",
"func",
".",
"metadata",
".",
"load_from_doc",
"=",
"True",
"if",
"func",
".",
"decorated",
":",
"return",
"func",
"func",
".",
"decorated",
"=",
"True",
"return",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | annotated | Mark a function as callable from the command line.
This function is meant to be called as decorator. This function
also initializes metadata about the function's arguments that is
built up by the param decorator.
Args:
func (callable): The function that we wish to mark as callable
... | typedargs/annotate.py | def annotated(func, name=None):
"""Mark a function as callable from the command line.
This function is meant to be called as decorator. This function
also initializes metadata about the function's arguments that is
built up by the param decorator.
Args:
func (callable): The function that ... | def annotated(func, name=None):
"""Mark a function as callable from the command line.
This function is meant to be called as decorator. This function
also initializes metadata about the function's arguments that is
built up by the param decorator.
Args:
func (callable): The function that ... | [
"Mark",
"a",
"function",
"as",
"callable",
"from",
"the",
"command",
"line",
"."
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/annotate.py#L250-L276 | [
"def",
"annotated",
"(",
"func",
",",
"name",
"=",
"None",
")",
":",
"if",
"hasattr",
"(",
"func",
",",
"'metadata'",
")",
":",
"if",
"name",
"is",
"not",
"None",
":",
"func",
".",
"metadata",
"=",
"AnnotatedMetadata",
"(",
"func",
",",
"name",
")",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | short_description | Given an object with a docstring, return the first line of the docstring | typedargs/annotate.py | def short_description(func):
"""
Given an object with a docstring, return the first line of the docstring
"""
doc = inspect.getdoc(func)
if doc is not None:
doc = inspect.cleandoc(doc)
lines = doc.splitlines()
return lines[0]
return "" | def short_description(func):
"""
Given an object with a docstring, return the first line of the docstring
"""
doc = inspect.getdoc(func)
if doc is not None:
doc = inspect.cleandoc(doc)
lines = doc.splitlines()
return lines[0]
return "" | [
"Given",
"an",
"object",
"with",
"a",
"docstring",
"return",
"the",
"first",
"line",
"of",
"the",
"docstring"
] | iotile/typedargs | python | https://github.com/iotile/typedargs/blob/0a5091a664b9b4d836e091e9ba583e944f438fd8/typedargs/annotate.py#L279-L290 | [
"def",
"short_description",
"(",
"func",
")",
":",
"doc",
"=",
"inspect",
".",
"getdoc",
"(",
"func",
")",
"if",
"doc",
"is",
"not",
"None",
":",
"doc",
"=",
"inspect",
".",
"cleandoc",
"(",
"doc",
")",
"lines",
"=",
"doc",
".",
"splitlines",
"(",
... | 0a5091a664b9b4d836e091e9ba583e944f438fd8 |
test | load | Load ``cron`` modules for applications listed in ``INSTALLED_APPS``. | kronos/__init__.py | def load():
"""
Load ``cron`` modules for applications listed in ``INSTALLED_APPS``.
"""
autodiscover_modules('cron')
if PROJECT_MODULE:
if '.' in PROJECT_MODULE.__name__:
try:
import_module('%s.cron' % '.'.join(
PROJECT_MODULE.__name__.split(... | def load():
"""
Load ``cron`` modules for applications listed in ``INSTALLED_APPS``.
"""
autodiscover_modules('cron')
if PROJECT_MODULE:
if '.' in PROJECT_MODULE.__name__:
try:
import_module('%s.cron' % '.'.join(
PROJECT_MODULE.__name__.split(... | [
"Load",
"cron",
"modules",
"for",
"applications",
"listed",
"in",
"INSTALLED_APPS",
"."
] | jgorset/django-kronos | python | https://github.com/jgorset/django-kronos/blob/82ca16f5d499de3d34e0677e64ffab62d45424ce/kronos/__init__.py#L25-L45 | [
"def",
"load",
"(",
")",
":",
"autodiscover_modules",
"(",
"'cron'",
")",
"if",
"PROJECT_MODULE",
":",
"if",
"'.'",
"in",
"PROJECT_MODULE",
".",
"__name__",
":",
"try",
":",
"import_module",
"(",
"'%s.cron'",
"%",
"'.'",
".",
"join",
"(",
"PROJECT_MODULE",
... | 82ca16f5d499de3d34e0677e64ffab62d45424ce |
test | install | Register tasks with cron. | kronos/__init__.py | def install():
"""
Register tasks with cron.
"""
load()
tab = crontab.CronTab(user=True)
for task in registry:
tab.new(task.command, KRONOS_BREADCRUMB).setall(task.schedule)
tab.write()
return len(registry) | def install():
"""
Register tasks with cron.
"""
load()
tab = crontab.CronTab(user=True)
for task in registry:
tab.new(task.command, KRONOS_BREADCRUMB).setall(task.schedule)
tab.write()
return len(registry) | [
"Register",
"tasks",
"with",
"cron",
"."
] | jgorset/django-kronos | python | https://github.com/jgorset/django-kronos/blob/82ca16f5d499de3d34e0677e64ffab62d45424ce/kronos/__init__.py#L117-L126 | [
"def",
"install",
"(",
")",
":",
"load",
"(",
")",
"tab",
"=",
"crontab",
".",
"CronTab",
"(",
"user",
"=",
"True",
")",
"for",
"task",
"in",
"registry",
":",
"tab",
".",
"new",
"(",
"task",
".",
"command",
",",
"KRONOS_BREADCRUMB",
")",
".",
"seta... | 82ca16f5d499de3d34e0677e64ffab62d45424ce |
test | printtasks | Print the tasks that would be installed in the
crontab, for debugging purposes. | kronos/__init__.py | def printtasks():
"""
Print the tasks that would be installed in the
crontab, for debugging purposes.
"""
load()
tab = crontab.CronTab('')
for task in registry:
tab.new(task.command, KRONOS_BREADCRUMB).setall(task.schedule)
print(tab.render()) | def printtasks():
"""
Print the tasks that would be installed in the
crontab, for debugging purposes.
"""
load()
tab = crontab.CronTab('')
for task in registry:
tab.new(task.command, KRONOS_BREADCRUMB).setall(task.schedule)
print(tab.render()) | [
"Print",
"the",
"tasks",
"that",
"would",
"be",
"installed",
"in",
"the",
"crontab",
"for",
"debugging",
"purposes",
"."
] | jgorset/django-kronos | python | https://github.com/jgorset/django-kronos/blob/82ca16f5d499de3d34e0677e64ffab62d45424ce/kronos/__init__.py#L129-L139 | [
"def",
"printtasks",
"(",
")",
":",
"load",
"(",
")",
"tab",
"=",
"crontab",
".",
"CronTab",
"(",
"''",
")",
"for",
"task",
"in",
"registry",
":",
"tab",
".",
"new",
"(",
"task",
".",
"command",
",",
"KRONOS_BREADCRUMB",
")",
".",
"setall",
"(",
"t... | 82ca16f5d499de3d34e0677e64ffab62d45424ce |
test | uninstall | Uninstall tasks from cron. | kronos/__init__.py | def uninstall():
"""
Uninstall tasks from cron.
"""
tab = crontab.CronTab(user=True)
count = len(list(tab.find_comment(KRONOS_BREADCRUMB)))
tab.remove_all(comment=KRONOS_BREADCRUMB)
tab.write()
return count | def uninstall():
"""
Uninstall tasks from cron.
"""
tab = crontab.CronTab(user=True)
count = len(list(tab.find_comment(KRONOS_BREADCRUMB)))
tab.remove_all(comment=KRONOS_BREADCRUMB)
tab.write()
return count | [
"Uninstall",
"tasks",
"from",
"cron",
"."
] | jgorset/django-kronos | python | https://github.com/jgorset/django-kronos/blob/82ca16f5d499de3d34e0677e64ffab62d45424ce/kronos/__init__.py#L142-L150 | [
"def",
"uninstall",
"(",
")",
":",
"tab",
"=",
"crontab",
".",
"CronTab",
"(",
"user",
"=",
"True",
")",
"count",
"=",
"len",
"(",
"list",
"(",
"tab",
".",
"find_comment",
"(",
"KRONOS_BREADCRUMB",
")",
")",
")",
"tab",
".",
"remove_all",
"(",
"comme... | 82ca16f5d499de3d34e0677e64ffab62d45424ce |
test | ProjectHandlerFactory.create | Create a project handler
Args:
uri (str): schema://something formatted uri
local_path (str): the project configs directory
Return:
ProjectHandler derived class instance | vcp/project_handler_base.py | def create(self, uri, local_path):
"""Create a project handler
Args:
uri (str): schema://something formatted uri
local_path (str): the project configs directory
Return:
ProjectHandler derived class instance
"""
matches = self.schema_pattern.s... | def create(self, uri, local_path):
"""Create a project handler
Args:
uri (str): schema://something formatted uri
local_path (str): the project configs directory
Return:
ProjectHandler derived class instance
"""
matches = self.schema_pattern.s... | [
"Create",
"a",
"project",
"handler"
] | voidpp/vcp | python | https://github.com/voidpp/vcp/blob/5538cdb7b43029db9aac9edad823cd87afd89ab5/vcp/project_handler_base.py#L18-L37 | [
"def",
"create",
"(",
"self",
",",
"uri",
",",
"local_path",
")",
":",
"matches",
"=",
"self",
".",
"schema_pattern",
".",
"search",
"(",
"uri",
")",
"if",
"not",
"matches",
":",
"logger",
".",
"error",
"(",
"\"Unknown uri schema: '%s'. Added schemas: %s\"",
... | 5538cdb7b43029db9aac9edad823cd87afd89ab5 |
test | ProjectHandlerBase.load | Load the projects config data from local path
Returns:
Dict: project_name -> project_data | vcp/project_handler_base.py | def load(self):
"""Load the projects config data from local path
Returns:
Dict: project_name -> project_data
"""
projects = {}
path = os.path.expanduser(self.path)
if not os.path.isdir(path):
return projects
logger.debug("Load project c... | def load(self):
"""Load the projects config data from local path
Returns:
Dict: project_name -> project_data
"""
projects = {}
path = os.path.expanduser(self.path)
if not os.path.isdir(path):
return projects
logger.debug("Load project c... | [
"Load",
"the",
"projects",
"config",
"data",
"from",
"local",
"path"
] | voidpp/vcp | python | https://github.com/voidpp/vcp/blob/5538cdb7b43029db9aac9edad823cd87afd89ab5/vcp/project_handler_base.py#L56-L88 | [
"def",
"load",
"(",
"self",
")",
":",
"projects",
"=",
"{",
"}",
"path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"self",
".",
"path",
")",
"if",
"not",
"os",
".",
"path",
".",
"isdir",
"(",
"path",
")",
":",
"return",
"projects",
"logger"... | 5538cdb7b43029db9aac9edad823cd87afd89ab5 |
test | ProjectHandlerBase.save | Save the projects configs to local path
Args:
projects (dict): project_name -> project_data | vcp/project_handler_base.py | def save(self, projects):
"""Save the projects configs to local path
Args:
projects (dict): project_name -> project_data
"""
base_path = os.path.expanduser(self.path)
if not os.path.isdir(base_path):
return
logger.debug("Save projects config to... | def save(self, projects):
"""Save the projects configs to local path
Args:
projects (dict): project_name -> project_data
"""
base_path = os.path.expanduser(self.path)
if not os.path.isdir(base_path):
return
logger.debug("Save projects config to... | [
"Save",
"the",
"projects",
"configs",
"to",
"local",
"path"
] | voidpp/vcp | python | https://github.com/voidpp/vcp/blob/5538cdb7b43029db9aac9edad823cd87afd89ab5/vcp/project_handler_base.py#L90-L108 | [
"def",
"save",
"(",
"self",
",",
"projects",
")",
":",
"base_path",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"self",
".",
"path",
")",
"if",
"not",
"os",
".",
"path",
".",
"isdir",
"(",
"base_path",
")",
":",
"return",
"logger",
".",
"debug"... | 5538cdb7b43029db9aac9edad823cd87afd89ab5 |
test | define_singleton | Creates a property with the given name, but the cls will created only with the first call
Args:
carrier: an instance of the class where want to reach the cls instance
name (str): the variable name of the cls instance
cls (type): the singleton object type
cls_args (dict): optional di... | vcp/tools.py | def define_singleton(carrier, name, cls, cls_args = {}):
"""Creates a property with the given name, but the cls will created only with the first call
Args:
carrier: an instance of the class where want to reach the cls instance
name (str): the variable name of the cls instance
cls (type)... | def define_singleton(carrier, name, cls, cls_args = {}):
"""Creates a property with the given name, but the cls will created only with the first call
Args:
carrier: an instance of the class where want to reach the cls instance
name (str): the variable name of the cls instance
cls (type)... | [
"Creates",
"a",
"property",
"with",
"the",
"given",
"name",
"but",
"the",
"cls",
"will",
"created",
"only",
"with",
"the",
"first",
"call"
] | voidpp/vcp | python | https://github.com/voidpp/vcp/blob/5538cdb7b43029db9aac9edad823cd87afd89ab5/vcp/tools.py#L84-L106 | [
"def",
"define_singleton",
"(",
"carrier",
",",
"name",
",",
"cls",
",",
"cls_args",
"=",
"{",
"}",
")",
":",
"instance_name",
"=",
"\"__{}\"",
".",
"format",
"(",
"name",
")",
"setattr",
"(",
"carrier",
",",
"instance_name",
",",
"None",
")",
"def",
"... | 5538cdb7b43029db9aac9edad823cd87afd89ab5 |
test | Project.get_dependent_projects | Get the dependencies of the Project
Args:
recursive (bool): add the dependant project's dependencies too
Returns:
dict of project name and project instances | vcp/project.py | def get_dependent_projects(self, recursive = True):
"""Get the dependencies of the Project
Args:
recursive (bool): add the dependant project's dependencies too
Returns:
dict of project name and project instances
"""
projects = {}
for name, ref in... | def get_dependent_projects(self, recursive = True):
"""Get the dependencies of the Project
Args:
recursive (bool): add the dependant project's dependencies too
Returns:
dict of project name and project instances
"""
projects = {}
for name, ref in... | [
"Get",
"the",
"dependencies",
"of",
"the",
"Project"
] | voidpp/vcp | python | https://github.com/voidpp/vcp/blob/5538cdb7b43029db9aac9edad823cd87afd89ab5/vcp/project.py#L238-L257 | [
"def",
"get_dependent_projects",
"(",
"self",
",",
"recursive",
"=",
"True",
")",
":",
"projects",
"=",
"{",
"}",
"for",
"name",
",",
"ref",
"in",
"list",
"(",
"self",
".",
"dependencies",
".",
"items",
"(",
")",
")",
":",
"try",
":",
"prj",
"=",
"... | 5538cdb7b43029db9aac9edad823cd87afd89ab5 |
test | post_process | Calls the project handler same named function
Note: the project handler may add some extra arguments to the command,
so when use this decorator, add **kwargs to the end of the arguments | vcp/commands.py | def post_process(func):
"""Calls the project handler same named function
Note: the project handler may add some extra arguments to the command,
so when use this decorator, add **kwargs to the end of the arguments
"""
@wraps(func)
def wrapper(*args, **kwargs):
res = func(*args, **... | def post_process(func):
"""Calls the project handler same named function
Note: the project handler may add some extra arguments to the command,
so when use this decorator, add **kwargs to the end of the arguments
"""
@wraps(func)
def wrapper(*args, **kwargs):
res = func(*args, **... | [
"Calls",
"the",
"project",
"handler",
"same",
"named",
"function"
] | voidpp/vcp | python | https://github.com/voidpp/vcp/blob/5538cdb7b43029db9aac9edad823cd87afd89ab5/vcp/commands.py#L19-L37 | [
"def",
"post_process",
"(",
"func",
")",
":",
"@",
"wraps",
"(",
"func",
")",
"def",
"wrapper",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"res",
"=",
"func",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"project_command",
"=",
"args... | 5538cdb7b43029db9aac9edad823cd87afd89ab5 |
test | ProjectCommand.__init | REFACTOR status to project init result ENUM
jelenleg ha a project init False, akkor torlunk minden adatot a projectrol
de van egy atmenet, mikor csak a lang init nem sikerult
erre valo jelenleg a status. ez rossz | vcp/commands.py | def __init(self, project, path, force, init_languages):
status = {}
"""
REFACTOR status to project init result ENUM
jelenleg ha a project init False, akkor torlunk minden adatot a projectrol
de van egy atmenet, mikor csak a lang init nem sikerult
erre valo jelenleg a stat... | def __init(self, project, path, force, init_languages):
status = {}
"""
REFACTOR status to project init result ENUM
jelenleg ha a project init False, akkor torlunk minden adatot a projectrol
de van egy atmenet, mikor csak a lang init nem sikerult
erre valo jelenleg a stat... | [
"REFACTOR",
"status",
"to",
"project",
"init",
"result",
"ENUM",
"jelenleg",
"ha",
"a",
"project",
"init",
"False",
"akkor",
"torlunk",
"minden",
"adatot",
"a",
"projectrol",
"de",
"van",
"egy",
"atmenet",
"mikor",
"csak",
"a",
"lang",
"init",
"nem",
"sikeru... | voidpp/vcp | python | https://github.com/voidpp/vcp/blob/5538cdb7b43029db9aac9edad823cd87afd89ab5/vcp/commands.py#L73-L89 | [
"def",
"__init",
"(",
"self",
",",
"project",
",",
"path",
",",
"force",
",",
"init_languages",
")",
":",
"status",
"=",
"{",
"}",
"project",
".",
"init",
"(",
"path",
",",
"status",
",",
"force",
",",
"init_languages",
"=",
"init_languages",
")",
"fai... | 5538cdb7b43029db9aac9edad823cd87afd89ab5 |
test | setitem | Takes an object, a key, and a value and produces a new object
that is a copy of the original but with ``value`` as the new value of
``key``.
The following equality should hold for your definition:
.. code-block:: python
setitem(obj, key, obj[key]) == obj
This function is used by many len... | lenses/hooks/hook_funcs.py | def setitem(self, key, value):
# type: (Any, Any, Any) -> Any
'''Takes an object, a key, and a value and produces a new object
that is a copy of the original but with ``value`` as the new value of
``key``.
The following equality should hold for your definition:
.. code-block:: python
... | def setitem(self, key, value):
# type: (Any, Any, Any) -> Any
'''Takes an object, a key, and a value and produces a new object
that is a copy of the original but with ``value`` as the new value of
``key``.
The following equality should hold for your definition:
.. code-block:: python
... | [
"Takes",
"an",
"object",
"a",
"key",
"and",
"a",
"value",
"and",
"produces",
"a",
"new",
"object",
"that",
"is",
"a",
"copy",
"of",
"the",
"original",
"but",
"with",
"value",
"as",
"the",
"new",
"value",
"of",
"key",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/hooks/hook_funcs.py#L43-L77 | [
"def",
"setitem",
"(",
"self",
",",
"key",
",",
"value",
")",
":",
"# type: (Any, Any, Any) -> Any",
"try",
":",
"self",
".",
"_lens_setitem",
"except",
"AttributeError",
":",
"selfcopy",
"=",
"copy",
".",
"copy",
"(",
"self",
")",
"selfcopy",
"[",
"key",
... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | setattr | Takes an object, a string, and a value and produces a new object
that is a copy of the original but with the attribute called ``name``
set to ``value``.
The following equality should hold for your definition:
.. code-block:: python
setattr(obj, 'attr', obj.attr) == obj
This function is u... | lenses/hooks/hook_funcs.py | def setattr(self, name, value):
# type: (Any, Any, Any) -> Any
'''Takes an object, a string, and a value and produces a new object
that is a copy of the original but with the attribute called ``name``
set to ``value``.
The following equality should hold for your definition:
.. code-block:: pyt... | def setattr(self, name, value):
# type: (Any, Any, Any) -> Any
'''Takes an object, a string, and a value and produces a new object
that is a copy of the original but with the attribute called ``name``
set to ``value``.
The following equality should hold for your definition:
.. code-block:: pyt... | [
"Takes",
"an",
"object",
"a",
"string",
"and",
"a",
"value",
"and",
"produces",
"a",
"new",
"object",
"that",
"is",
"a",
"copy",
"of",
"the",
"original",
"but",
"with",
"the",
"attribute",
"called",
"name",
"set",
"to",
"value",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/hooks/hook_funcs.py#L121-L155 | [
"def",
"setattr",
"(",
"self",
",",
"name",
",",
"value",
")",
":",
"# type: (Any, Any, Any) -> Any",
"try",
":",
"self",
".",
"_lens_setattr",
"except",
"AttributeError",
":",
"selfcopy",
"=",
"copy",
".",
"copy",
"(",
"self",
")",
"builtin_setattr",
"(",
"... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | contains_add | Takes a collection and an item and returns a new collection
of the same type that contains the item. The notion of "contains"
is defined by the object itself; The following must be ``True``:
.. code-block:: python
item in contains_add(obj, item)
This function is used by some lenses (particula... | lenses/hooks/hook_funcs.py | def contains_add(self, item):
# type (Any, Any) -> Any
'''Takes a collection and an item and returns a new collection
of the same type that contains the item. The notion of "contains"
is defined by the object itself; The following must be ``True``:
.. code-block:: python
item in contains_a... | def contains_add(self, item):
# type (Any, Any) -> Any
'''Takes a collection and an item and returns a new collection
of the same type that contains the item. The notion of "contains"
is defined by the object itself; The following must be ``True``:
.. code-block:: python
item in contains_a... | [
"Takes",
"a",
"collection",
"and",
"an",
"item",
"and",
"returns",
"a",
"new",
"collection",
"of",
"the",
"same",
"type",
"that",
"contains",
"the",
"item",
".",
"The",
"notion",
"of",
"contains",
"is",
"defined",
"by",
"the",
"object",
"itself",
";",
"T... | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/hooks/hook_funcs.py#L171-L195 | [
"def",
"contains_add",
"(",
"self",
",",
"item",
")",
":",
"# type (Any, Any) -> Any",
"try",
":",
"self",
".",
"_lens_contains_add",
"except",
"AttributeError",
":",
"message",
"=",
"'Don\\'t know how to add an item to {}'",
"raise",
"NotImplementedError",
"(",
"messag... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | contains_remove | Takes a collection and an item and returns a new collection
of the same type with that item removed. The notion of "contains"
is defined by the object itself; the following must be ``True``:
.. code-block:: python
item not in contains_remove(obj, item)
This function is used by some lenses (pa... | lenses/hooks/hook_funcs.py | def contains_remove(self, item):
# type (Any, Any) -> Any
'''Takes a collection and an item and returns a new collection
of the same type with that item removed. The notion of "contains"
is defined by the object itself; the following must be ``True``:
.. code-block:: python
item not in con... | def contains_remove(self, item):
# type (Any, Any) -> Any
'''Takes a collection and an item and returns a new collection
of the same type with that item removed. The notion of "contains"
is defined by the object itself; the following must be ``True``:
.. code-block:: python
item not in con... | [
"Takes",
"a",
"collection",
"and",
"an",
"item",
"and",
"returns",
"a",
"new",
"collection",
"of",
"the",
"same",
"type",
"with",
"that",
"item",
"removed",
".",
"The",
"notion",
"of",
"contains",
"is",
"defined",
"by",
"the",
"object",
"itself",
";",
"t... | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/hooks/hook_funcs.py#L225-L249 | [
"def",
"contains_remove",
"(",
"self",
",",
"item",
")",
":",
"# type (Any, Any) -> Any",
"try",
":",
"self",
".",
"_lens_contains_remove",
"except",
"AttributeError",
":",
"message",
"=",
"'Don\\'t know how to remove an item from {}'",
"raise",
"NotImplementedError",
"("... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | from_iter | Takes an object and an iterable and produces a new object that is
a copy of the original with data from ``iterable`` reincorporated. It
is intended as the inverse of the ``to_iter`` function. Any state in
``self`` that is not modelled by the iterable should remain unchanged.
The following equality shou... | lenses/hooks/hook_funcs.py | def from_iter(self, iterable):
# type: (Any, Any) -> Any
'''Takes an object and an iterable and produces a new object that is
a copy of the original with data from ``iterable`` reincorporated. It
is intended as the inverse of the ``to_iter`` function. Any state in
``self`` that is not modelled by th... | def from_iter(self, iterable):
# type: (Any, Any) -> Any
'''Takes an object and an iterable and produces a new object that is
a copy of the original with data from ``iterable`` reincorporated. It
is intended as the inverse of the ``to_iter`` function. Any state in
``self`` that is not modelled by th... | [
"Takes",
"an",
"object",
"and",
"an",
"iterable",
"and",
"produces",
"a",
"new",
"object",
"that",
"is",
"a",
"copy",
"of",
"the",
"original",
"with",
"data",
"from",
"iterable",
"reincorporated",
".",
"It",
"is",
"intended",
"as",
"the",
"inverse",
"of",
... | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/hooks/hook_funcs.py#L310-L337 | [
"def",
"from_iter",
"(",
"self",
",",
"iterable",
")",
":",
"# type: (Any, Any) -> Any",
"try",
":",
"self",
".",
"_lens_from_iter",
"except",
"AttributeError",
":",
"message",
"=",
"'Don\\'t know how to create instance of {} from iterable'",
"raise",
"NotImplementedError",... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | UnboundLens.set | Set the focus to `newvalue`.
>>> from lenses import lens
>>> set_item_one_to_four = lens[1].set(4)
>>> set_item_one_to_four([1, 2, 3])
[1, 4, 3] | lenses/ui/__init__.py | def set(self, newvalue):
# type: (B) -> Callable[[S], T]
'''Set the focus to `newvalue`.
>>> from lenses import lens
>>> set_item_one_to_four = lens[1].set(4)
>>> set_item_one_to_four([1, 2, 3])
[1, 4, 3]
'''
def setter(state):
... | def set(self, newvalue):
# type: (B) -> Callable[[S], T]
'''Set the focus to `newvalue`.
>>> from lenses import lens
>>> set_item_one_to_four = lens[1].set(4)
>>> set_item_one_to_four([1, 2, 3])
[1, 4, 3]
'''
def setter(state):
... | [
"Set",
"the",
"focus",
"to",
"newvalue",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/ui/__init__.py#L71-L84 | [
"def",
"set",
"(",
"self",
",",
"newvalue",
")",
":",
"# type: (B) -> Callable[[S], T]",
"def",
"setter",
"(",
"state",
")",
":",
"return",
"self",
".",
"_optic",
".",
"set",
"(",
"state",
",",
"newvalue",
")",
"return",
"setter"
] | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | UnboundLens.set_many | Set many foci to values taken by iterating over `new_values`.
>>> from lenses import lens
>>> lens.Each().set_many(range(4, 7))([0, 1, 2])
[4, 5, 6] | lenses/ui/__init__.py | def set_many(self, new_values):
# type: (Iterable[B]) -> Callable[[S], T]
'''Set many foci to values taken by iterating over `new_values`.
>>> from lenses import lens
>>> lens.Each().set_many(range(4, 7))([0, 1, 2])
[4, 5, 6]
'''
def setter_many(stat... | def set_many(self, new_values):
# type: (Iterable[B]) -> Callable[[S], T]
'''Set many foci to values taken by iterating over `new_values`.
>>> from lenses import lens
>>> lens.Each().set_many(range(4, 7))([0, 1, 2])
[4, 5, 6]
'''
def setter_many(stat... | [
"Set",
"many",
"foci",
"to",
"values",
"taken",
"by",
"iterating",
"over",
"new_values",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/ui/__init__.py#L86-L98 | [
"def",
"set_many",
"(",
"self",
",",
"new_values",
")",
":",
"# type: (Iterable[B]) -> Callable[[S], T]",
"def",
"setter_many",
"(",
"state",
")",
":",
"return",
"self",
".",
"_optic",
".",
"iterate",
"(",
"state",
",",
"new_values",
")",
"return",
"setter_many"... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | UnboundLens.modify | Apply a function to the focus.
>>> from lenses import lens
>>> convert_item_one_to_string = lens[1].modify(str)
>>> convert_item_one_to_string([1, 2, 3])
[1, '2', 3]
>>> add_ten_to_item_one = lens[1].modify(lambda n: n + 10)
>>> add_ten_to_item_on... | lenses/ui/__init__.py | def modify(self, func):
# type: (Callable[[A], B]) -> Callable[[S], T]
'''Apply a function to the focus.
>>> from lenses import lens
>>> convert_item_one_to_string = lens[1].modify(str)
>>> convert_item_one_to_string([1, 2, 3])
[1, '2', 3]
>>>... | def modify(self, func):
# type: (Callable[[A], B]) -> Callable[[S], T]
'''Apply a function to the focus.
>>> from lenses import lens
>>> convert_item_one_to_string = lens[1].modify(str)
>>> convert_item_one_to_string([1, 2, 3])
[1, '2', 3]
>>>... | [
"Apply",
"a",
"function",
"to",
"the",
"focus",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/ui/__init__.py#L100-L116 | [
"def",
"modify",
"(",
"self",
",",
"func",
")",
":",
"# type: (Callable[[A], B]) -> Callable[[S], T]",
"def",
"modifier",
"(",
"state",
")",
":",
"return",
"self",
".",
"_optic",
".",
"over",
"(",
"state",
",",
"func",
")",
"return",
"modifier"
] | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | multiap | Applies `func` to the data inside the `args` functors
incrementally. `func` must be a curried function that takes
`len(args)` arguments.
>>> func = lambda a: lambda b: a + b
>>> multiap(func, [1, 10], [100])
[101, 110] | lenses/optics/base.py | def multiap(func, *args):
'''Applies `func` to the data inside the `args` functors
incrementally. `func` must be a curried function that takes
`len(args)` arguments.
>>> func = lambda a: lambda b: a + b
>>> multiap(func, [1, 10], [100])
[101, 110]
'''
functor = typeclass.fma... | def multiap(func, *args):
'''Applies `func` to the data inside the `args` functors
incrementally. `func` must be a curried function that takes
`len(args)` arguments.
>>> func = lambda a: lambda b: a + b
>>> multiap(func, [1, 10], [100])
[101, 110]
'''
functor = typeclass.fma... | [
"Applies",
"func",
"to",
"the",
"data",
"inside",
"the",
"args",
"functors",
"incrementally",
".",
"func",
"must",
"be",
"a",
"curried",
"function",
"that",
"takes",
"len",
"(",
"args",
")",
"arguments",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/optics/base.py#L11-L23 | [
"def",
"multiap",
"(",
"func",
",",
"*",
"args",
")",
":",
"functor",
"=",
"typeclass",
".",
"fmap",
"(",
"args",
"[",
"0",
"]",
",",
"func",
")",
"for",
"arg",
"in",
"args",
"[",
"1",
":",
"]",
":",
"functor",
"=",
"typeclass",
".",
"apply",
"... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | collect_args | Returns a function that can be called `n` times with a single
argument before returning all the args that have been passed to it
in a tuple. Useful as a substitute for functions that can't easily be
curried.
>>> collect_args(3)(1)(2)(3)
(1, 2, 3) | lenses/optics/base.py | def collect_args(n):
'''Returns a function that can be called `n` times with a single
argument before returning all the args that have been passed to it
in a tuple. Useful as a substitute for functions that can't easily be
curried.
>>> collect_args(3)(1)(2)(3)
(1, 2, 3)
'''
args... | def collect_args(n):
'''Returns a function that can be called `n` times with a single
argument before returning all the args that have been passed to it
in a tuple. Useful as a substitute for functions that can't easily be
curried.
>>> collect_args(3)(1)(2)(3)
(1, 2, 3)
'''
args... | [
"Returns",
"a",
"function",
"that",
"can",
"be",
"called",
"n",
"times",
"with",
"a",
"single",
"argument",
"before",
"returning",
"all",
"the",
"args",
"that",
"have",
"been",
"passed",
"to",
"it",
"in",
"a",
"tuple",
".",
"Useful",
"as",
"a",
"substitu... | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/optics/base.py#L26-L44 | [
"def",
"collect_args",
"(",
"n",
")",
":",
"args",
"=",
"[",
"]",
"def",
"arg_collector",
"(",
"arg",
")",
":",
"args",
".",
"append",
"(",
"arg",
")",
"if",
"len",
"(",
"args",
")",
"==",
"n",
":",
"return",
"tuple",
"(",
"args",
")",
"else",
... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | LensLike.func | Intended to be overridden by subclasses. Raises
NotImplementedError. | lenses/optics/base.py | def func(self, f, state):
'''Intended to be overridden by subclasses. Raises
NotImplementedError.'''
message = 'Tried to use unimplemented lens {}.'
raise NotImplementedError(message.format(type(self))) | def func(self, f, state):
'''Intended to be overridden by subclasses. Raises
NotImplementedError.'''
message = 'Tried to use unimplemented lens {}.'
raise NotImplementedError(message.format(type(self))) | [
"Intended",
"to",
"be",
"overridden",
"by",
"subclasses",
".",
"Raises",
"NotImplementedError",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/optics/base.py#L122-L126 | [
"def",
"func",
"(",
"self",
",",
"f",
",",
"state",
")",
":",
"message",
"=",
"'Tried to use unimplemented lens {}.'",
"raise",
"NotImplementedError",
"(",
"message",
".",
"format",
"(",
"type",
"(",
"self",
")",
")",
")"
] | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | LensLike.apply | Runs the lens over the `state` applying `f` to all the foci
collecting the results together using the applicative functor
functions defined in `lenses.typeclass`. `f` must return an
applicative functor. For the case when no focus exists you must
also provide a `pure` which should take a ... | lenses/optics/base.py | def apply(self, f, pure, state):
'''Runs the lens over the `state` applying `f` to all the foci
collecting the results together using the applicative functor
functions defined in `lenses.typeclass`. `f` must return an
applicative functor. For the case when no focus exists you must
... | def apply(self, f, pure, state):
'''Runs the lens over the `state` applying `f` to all the foci
collecting the results together using the applicative functor
functions defined in `lenses.typeclass`. `f` must return an
applicative functor. For the case when no focus exists you must
... | [
"Runs",
"the",
"lens",
"over",
"the",
"state",
"applying",
"f",
"to",
"all",
"the",
"foci",
"collecting",
"the",
"results",
"together",
"using",
"the",
"applicative",
"functor",
"functions",
"defined",
"in",
"lenses",
".",
"typeclass",
".",
"f",
"must",
"ret... | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/optics/base.py#L128-L136 | [
"def",
"apply",
"(",
"self",
",",
"f",
",",
"pure",
",",
"state",
")",
":",
"return",
"self",
".",
"func",
"(",
"Functorisor",
"(",
"pure",
",",
"f",
")",
",",
"state",
")"
] | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | LensLike.preview | Previews a potentially non-existant focus within
`state`. Returns `Just(focus)` if it exists, Nothing otherwise.
Requires kind Fold. | lenses/optics/base.py | def preview(self, state):
# type: (S) -> Just[B]
'''Previews a potentially non-existant focus within
`state`. Returns `Just(focus)` if it exists, Nothing otherwise.
Requires kind Fold.
'''
if not self._is_kind(Fold):
raise TypeError('Must be an instance of Fo... | def preview(self, state):
# type: (S) -> Just[B]
'''Previews a potentially non-existant focus within
`state`. Returns `Just(focus)` if it exists, Nothing otherwise.
Requires kind Fold.
'''
if not self._is_kind(Fold):
raise TypeError('Must be an instance of Fo... | [
"Previews",
"a",
"potentially",
"non",
"-",
"existant",
"focus",
"within",
"state",
".",
"Returns",
"Just",
"(",
"focus",
")",
"if",
"it",
"exists",
"Nothing",
"otherwise",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/optics/base.py#L138-L150 | [
"def",
"preview",
"(",
"self",
",",
"state",
")",
":",
"# type: (S) -> Just[B]",
"if",
"not",
"self",
".",
"_is_kind",
"(",
"Fold",
")",
":",
"raise",
"TypeError",
"(",
"'Must be an instance of Fold to .preview()'",
")",
"pure",
"=",
"lambda",
"a",
":",
"Const... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | LensLike.view | Returns the focus within `state`. If multiple items are
focused then it will attempt to join them together as a monoid.
See `lenses.typeclass.mappend`.
Requires kind Fold. This method will raise TypeError if the
optic has no way to get any foci.
For technical reasons, this meth... | lenses/optics/base.py | def view(self, state):
# type: (S) -> B
'''Returns the focus within `state`. If multiple items are
focused then it will attempt to join them together as a monoid.
See `lenses.typeclass.mappend`.
Requires kind Fold. This method will raise TypeError if the
optic has no way... | def view(self, state):
# type: (S) -> B
'''Returns the focus within `state`. If multiple items are
focused then it will attempt to join them together as a monoid.
See `lenses.typeclass.mappend`.
Requires kind Fold. This method will raise TypeError if the
optic has no way... | [
"Returns",
"the",
"focus",
"within",
"state",
".",
"If",
"multiple",
"items",
"are",
"focused",
"then",
"it",
"will",
"attempt",
"to",
"join",
"them",
"together",
"as",
"a",
"monoid",
".",
"See",
"lenses",
".",
"typeclass",
".",
"mappend",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/optics/base.py#L152-L172 | [
"def",
"view",
"(",
"self",
",",
"state",
")",
":",
"# type: (S) -> B",
"if",
"not",
"self",
".",
"_is_kind",
"(",
"Fold",
")",
":",
"raise",
"TypeError",
"(",
"'Must be an instance of Fold to .view()'",
")",
"guard",
"=",
"object",
"(",
")",
"result",
"=",
... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | LensLike.to_list_of | Returns a list of all the foci within `state`.
Requires kind Fold. This method will raise TypeError if the
optic has no way to get any foci. | lenses/optics/base.py | def to_list_of(self, state):
# type: (S) -> List[B]
'''Returns a list of all the foci within `state`.
Requires kind Fold. This method will raise TypeError if the
optic has no way to get any foci.
'''
if not self._is_kind(Fold):
raise TypeError('Must be an ins... | def to_list_of(self, state):
# type: (S) -> List[B]
'''Returns a list of all the foci within `state`.
Requires kind Fold. This method will raise TypeError if the
optic has no way to get any foci.
'''
if not self._is_kind(Fold):
raise TypeError('Must be an ins... | [
"Returns",
"a",
"list",
"of",
"all",
"the",
"foci",
"within",
"state",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/optics/base.py#L174-L186 | [
"def",
"to_list_of",
"(",
"self",
",",
"state",
")",
":",
"# type: (S) -> List[B]",
"if",
"not",
"self",
".",
"_is_kind",
"(",
"Fold",
")",
":",
"raise",
"TypeError",
"(",
"'Must be an instance of Fold to .to_list_of()'",
")",
"pure",
"=",
"lambda",
"a",
":",
... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | LensLike.over | Applies a function `fn` to all the foci within `state`.
Requires kind Setter. This method will raise TypeError when the
optic has no way to set foci. | lenses/optics/base.py | def over(self, state, fn):
# type: (S, Callable[[A], B]) -> T
'''Applies a function `fn` to all the foci within `state`.
Requires kind Setter. This method will raise TypeError when the
optic has no way to set foci.
'''
if not self._is_kind(Setter):
raise Type... | def over(self, state, fn):
# type: (S, Callable[[A], B]) -> T
'''Applies a function `fn` to all the foci within `state`.
Requires kind Setter. This method will raise TypeError when the
optic has no way to set foci.
'''
if not self._is_kind(Setter):
raise Type... | [
"Applies",
"a",
"function",
"fn",
"to",
"all",
"the",
"foci",
"within",
"state",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/optics/base.py#L188-L200 | [
"def",
"over",
"(",
"self",
",",
"state",
",",
"fn",
")",
":",
"# type: (S, Callable[[A], B]) -> T",
"if",
"not",
"self",
".",
"_is_kind",
"(",
"Setter",
")",
":",
"raise",
"TypeError",
"(",
"'Must be an instance of Setter to .over()'",
")",
"pure",
"=",
"lambda... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | LensLike.set | Sets all the foci within `state` to `value`.
Requires kind Setter. This method will raise TypeError when the
optic has no way to set foci. | lenses/optics/base.py | def set(self, state, value):
# type: (S, B) -> T
'''Sets all the foci within `state` to `value`.
Requires kind Setter. This method will raise TypeError when the
optic has no way to set foci.
'''
if not self._is_kind(Setter):
raise TypeError('Must be an instan... | def set(self, state, value):
# type: (S, B) -> T
'''Sets all the foci within `state` to `value`.
Requires kind Setter. This method will raise TypeError when the
optic has no way to set foci.
'''
if not self._is_kind(Setter):
raise TypeError('Must be an instan... | [
"Sets",
"all",
"the",
"foci",
"within",
"state",
"to",
"value",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/optics/base.py#L202-L214 | [
"def",
"set",
"(",
"self",
",",
"state",
",",
"value",
")",
":",
"# type: (S, B) -> T",
"if",
"not",
"self",
".",
"_is_kind",
"(",
"Setter",
")",
":",
"raise",
"TypeError",
"(",
"'Must be an instance of Setter to .set()'",
")",
"pure",
"=",
"lambda",
"a",
":... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | LensLike.iterate | Sets all the foci within `state` to values taken from `iterable`.
Requires kind Setter. This method will raise TypeError when the
optic has no way to set foci. | lenses/optics/base.py | def iterate(self, state, iterable):
# type: (S, Iterable[B]) -> T
'''Sets all the foci within `state` to values taken from `iterable`.
Requires kind Setter. This method will raise TypeError when the
optic has no way to set foci.
'''
if not self._is_kind(Setter):
... | def iterate(self, state, iterable):
# type: (S, Iterable[B]) -> T
'''Sets all the foci within `state` to values taken from `iterable`.
Requires kind Setter. This method will raise TypeError when the
optic has no way to set foci.
'''
if not self._is_kind(Setter):
... | [
"Sets",
"all",
"the",
"foci",
"within",
"state",
"to",
"values",
"taken",
"from",
"iterable",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/optics/base.py#L216-L229 | [
"def",
"iterate",
"(",
"self",
",",
"state",
",",
"iterable",
")",
":",
"# type: (S, Iterable[B]) -> T",
"if",
"not",
"self",
".",
"_is_kind",
"(",
"Setter",
")",
":",
"raise",
"TypeError",
"(",
"'Must be an instance of Setter to .iterate()'",
")",
"i",
"=",
"it... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | LensLike.kind | Returns a class representing the 'kind' of optic. | lenses/optics/base.py | def kind(self):
'''Returns a class representing the 'kind' of optic.'''
optics = [
Equality,
Isomorphism,
Prism,
Review,
Lens,
Traversal,
Getter,
Setter,
Fold,
]
for optic in optic... | def kind(self):
'''Returns a class representing the 'kind' of optic.'''
optics = [
Equality,
Isomorphism,
Prism,
Review,
Lens,
Traversal,
Getter,
Setter,
Fold,
]
for optic in optic... | [
"Returns",
"a",
"class",
"representing",
"the",
"kind",
"of",
"optic",
"."
] | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/lenses/optics/base.py#L242-L257 | [
"def",
"kind",
"(",
"self",
")",
":",
"optics",
"=",
"[",
"Equality",
",",
"Isomorphism",
",",
"Prism",
",",
"Review",
",",
"Lens",
",",
"Traversal",
",",
"Getter",
",",
"Setter",
",",
"Fold",
",",
"]",
"for",
"optic",
"in",
"optics",
":",
"if",
"s... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
test | main | The main function. Instantiates a GameState object and then
enters a REPL-like main loop, waiting for input, updating the state
based on the input, then outputting the new state. | examples/robots.py | def main():
'''The main function. Instantiates a GameState object and then
enters a REPL-like main loop, waiting for input, updating the state
based on the input, then outputting the new state.'''
state = GameState()
print(state)
while state.running:
input = get_single_char()
s... | def main():
'''The main function. Instantiates a GameState object and then
enters a REPL-like main loop, waiting for input, updating the state
based on the input, then outputting the new state.'''
state = GameState()
print(state)
while state.running:
input = get_single_char()
s... | [
"The",
"main",
"function",
".",
"Instantiates",
"a",
"GameState",
"object",
"and",
"then",
"enters",
"a",
"REPL",
"-",
"like",
"main",
"loop",
"waiting",
"for",
"input",
"updating",
"the",
"state",
"based",
"on",
"the",
"input",
"then",
"outputting",
"the",
... | ingolemo/python-lenses | python | https://github.com/ingolemo/python-lenses/blob/a3a6ed0a31f6674451e542e7380a8aa16e6f8edf/examples/robots.py#L165-L182 | [
"def",
"main",
"(",
")",
":",
"state",
"=",
"GameState",
"(",
")",
"print",
"(",
"state",
")",
"while",
"state",
".",
"running",
":",
"input",
"=",
"get_single_char",
"(",
")",
"state",
",",
"should_advance",
"=",
"state",
".",
"handle_input",
"(",
"in... | a3a6ed0a31f6674451e542e7380a8aa16e6f8edf |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.