repo
stringlengths 7
55
| path
stringlengths 4
127
| func_name
stringlengths 1
88
| original_string
stringlengths 75
19.8k
| language
stringclasses 1
value | code
stringlengths 75
19.8k
| code_tokens
list | docstring
stringlengths 3
17.3k
| docstring_tokens
list | sha
stringlengths 40
40
| url
stringlengths 87
242
| partition
stringclasses 1
value |
|---|---|---|---|---|---|---|---|---|---|---|---|
limodou/uliweb
|
uliweb/core/html.py
|
to_attrs
|
def to_attrs(args, nocreate_if_none=['id', 'for', 'class']):
"""
Make python dict to k="v" format
"""
if not args:
return ''
s = ['']
for k, v in sorted(args.items()):
k = u_str(k)
v = u_str(v)
if k.startswith('_'):
k = k[1:]
if v is None:
if k not in nocreate_if_none:
s.append(k)
else:
if k.lower() in __noescape_attrs__:
t = u_str(v)
else:
t = cgi.escape(u_str(v))
t = '"%s"' % t.replace('"', '"')
s.append('%s=%s' % (k, t))
return ' '.join(s)
|
python
|
def to_attrs(args, nocreate_if_none=['id', 'for', 'class']):
"""
Make python dict to k="v" format
"""
if not args:
return ''
s = ['']
for k, v in sorted(args.items()):
k = u_str(k)
v = u_str(v)
if k.startswith('_'):
k = k[1:]
if v is None:
if k not in nocreate_if_none:
s.append(k)
else:
if k.lower() in __noescape_attrs__:
t = u_str(v)
else:
t = cgi.escape(u_str(v))
t = '"%s"' % t.replace('"', '"')
s.append('%s=%s' % (k, t))
return ' '.join(s)
|
[
"def",
"to_attrs",
"(",
"args",
",",
"nocreate_if_none",
"=",
"[",
"'id'",
",",
"'for'",
",",
"'class'",
"]",
")",
":",
"if",
"not",
"args",
":",
"return",
"''",
"s",
"=",
"[",
"''",
"]",
"for",
"k",
",",
"v",
"in",
"sorted",
"(",
"args",
".",
"items",
"(",
")",
")",
":",
"k",
"=",
"u_str",
"(",
"k",
")",
"v",
"=",
"u_str",
"(",
"v",
")",
"if",
"k",
".",
"startswith",
"(",
"'_'",
")",
":",
"k",
"=",
"k",
"[",
"1",
":",
"]",
"if",
"v",
"is",
"None",
":",
"if",
"k",
"not",
"in",
"nocreate_if_none",
":",
"s",
".",
"append",
"(",
"k",
")",
"else",
":",
"if",
"k",
".",
"lower",
"(",
")",
"in",
"__noescape_attrs__",
":",
"t",
"=",
"u_str",
"(",
"v",
")",
"else",
":",
"t",
"=",
"cgi",
".",
"escape",
"(",
"u_str",
"(",
"v",
")",
")",
"t",
"=",
"'\"%s\"'",
"%",
"t",
".",
"replace",
"(",
"'\"'",
",",
"'"'",
")",
"s",
".",
"append",
"(",
"'%s=%s'",
"%",
"(",
"k",
",",
"t",
")",
")",
"return",
"' '",
".",
"join",
"(",
"s",
")"
] |
Make python dict to k="v" format
|
[
"Make",
"python",
"dict",
"to",
"k",
"=",
"v",
"format"
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/core/html.py#L24-L46
|
train
|
limodou/uliweb
|
uliweb/i18n/pygettext.py
|
_get_modpkg_path
|
def _get_modpkg_path(dotted_name, pathlist=None):
"""Get the filesystem path for a module or a package.
Return the file system path to a file for a module, and to a directory for
a package. Return None if the name is not found, or is a builtin or
extension module.
"""
# split off top-most name
parts = dotted_name.split('.', 1)
if len(parts) > 1:
# we have a dotted path, import top-level package
try:
file, pathname, description = imp.find_module(parts[0], pathlist)
if file: file.close()
except ImportError:
return None
# check if it's indeed a package
if description[2] == imp.PKG_DIRECTORY:
# recursively handle the remaining name parts
pathname = _get_modpkg_path(parts[1], [pathname])
else:
pathname = None
else:
# plain name
try:
file, pathname, description = imp.find_module(
dotted_name, pathlist)
if file:
file.close()
if description[2] not in [imp.PY_SOURCE, imp.PKG_DIRECTORY]:
pathname = None
except ImportError:
pathname = None
return pathname
|
python
|
def _get_modpkg_path(dotted_name, pathlist=None):
"""Get the filesystem path for a module or a package.
Return the file system path to a file for a module, and to a directory for
a package. Return None if the name is not found, or is a builtin or
extension module.
"""
# split off top-most name
parts = dotted_name.split('.', 1)
if len(parts) > 1:
# we have a dotted path, import top-level package
try:
file, pathname, description = imp.find_module(parts[0], pathlist)
if file: file.close()
except ImportError:
return None
# check if it's indeed a package
if description[2] == imp.PKG_DIRECTORY:
# recursively handle the remaining name parts
pathname = _get_modpkg_path(parts[1], [pathname])
else:
pathname = None
else:
# plain name
try:
file, pathname, description = imp.find_module(
dotted_name, pathlist)
if file:
file.close()
if description[2] not in [imp.PY_SOURCE, imp.PKG_DIRECTORY]:
pathname = None
except ImportError:
pathname = None
return pathname
|
[
"def",
"_get_modpkg_path",
"(",
"dotted_name",
",",
"pathlist",
"=",
"None",
")",
":",
"# split off top-most name",
"parts",
"=",
"dotted_name",
".",
"split",
"(",
"'.'",
",",
"1",
")",
"if",
"len",
"(",
"parts",
")",
">",
"1",
":",
"# we have a dotted path, import top-level package",
"try",
":",
"file",
",",
"pathname",
",",
"description",
"=",
"imp",
".",
"find_module",
"(",
"parts",
"[",
"0",
"]",
",",
"pathlist",
")",
"if",
"file",
":",
"file",
".",
"close",
"(",
")",
"except",
"ImportError",
":",
"return",
"None",
"# check if it's indeed a package",
"if",
"description",
"[",
"2",
"]",
"==",
"imp",
".",
"PKG_DIRECTORY",
":",
"# recursively handle the remaining name parts",
"pathname",
"=",
"_get_modpkg_path",
"(",
"parts",
"[",
"1",
"]",
",",
"[",
"pathname",
"]",
")",
"else",
":",
"pathname",
"=",
"None",
"else",
":",
"# plain name",
"try",
":",
"file",
",",
"pathname",
",",
"description",
"=",
"imp",
".",
"find_module",
"(",
"dotted_name",
",",
"pathlist",
")",
"if",
"file",
":",
"file",
".",
"close",
"(",
")",
"if",
"description",
"[",
"2",
"]",
"not",
"in",
"[",
"imp",
".",
"PY_SOURCE",
",",
"imp",
".",
"PKG_DIRECTORY",
"]",
":",
"pathname",
"=",
"None",
"except",
"ImportError",
":",
"pathname",
"=",
"None",
"return",
"pathname"
] |
Get the filesystem path for a module or a package.
Return the file system path to a file for a module, and to a directory for
a package. Return None if the name is not found, or is a builtin or
extension module.
|
[
"Get",
"the",
"filesystem",
"path",
"for",
"a",
"module",
"or",
"a",
"package",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/i18n/pygettext.py#L314-L350
|
train
|
limodou/uliweb
|
uliweb/i18n/pygettext.py
|
getFilesForName
|
def getFilesForName(name):
"""Get a list of module files for a filename, a module or package name,
or a directory.
"""
if not os.path.exists(name):
# check for glob chars
if containsAny(name, "*?[]"):
files = glob.glob(name)
list = []
for file in files:
list.extend(getFilesForName(file))
return list
# try to find module or package
name = _get_modpkg_path(name)
if not name:
return []
if os.path.isdir(name):
# find all python files in directory
list = []
os.path.walk(name, _visit_pyfiles, list)
return list
elif os.path.exists(name):
# a single file
return [name]
return []
|
python
|
def getFilesForName(name):
"""Get a list of module files for a filename, a module or package name,
or a directory.
"""
if not os.path.exists(name):
# check for glob chars
if containsAny(name, "*?[]"):
files = glob.glob(name)
list = []
for file in files:
list.extend(getFilesForName(file))
return list
# try to find module or package
name = _get_modpkg_path(name)
if not name:
return []
if os.path.isdir(name):
# find all python files in directory
list = []
os.path.walk(name, _visit_pyfiles, list)
return list
elif os.path.exists(name):
# a single file
return [name]
return []
|
[
"def",
"getFilesForName",
"(",
"name",
")",
":",
"if",
"not",
"os",
".",
"path",
".",
"exists",
"(",
"name",
")",
":",
"# check for glob chars",
"if",
"containsAny",
"(",
"name",
",",
"\"*?[]\"",
")",
":",
"files",
"=",
"glob",
".",
"glob",
"(",
"name",
")",
"list",
"=",
"[",
"]",
"for",
"file",
"in",
"files",
":",
"list",
".",
"extend",
"(",
"getFilesForName",
"(",
"file",
")",
")",
"return",
"list",
"# try to find module or package",
"name",
"=",
"_get_modpkg_path",
"(",
"name",
")",
"if",
"not",
"name",
":",
"return",
"[",
"]",
"if",
"os",
".",
"path",
".",
"isdir",
"(",
"name",
")",
":",
"# find all python files in directory",
"list",
"=",
"[",
"]",
"os",
".",
"path",
".",
"walk",
"(",
"name",
",",
"_visit_pyfiles",
",",
"list",
")",
"return",
"list",
"elif",
"os",
".",
"path",
".",
"exists",
"(",
"name",
")",
":",
"# a single file",
"return",
"[",
"name",
"]",
"return",
"[",
"]"
] |
Get a list of module files for a filename, a module or package name,
or a directory.
|
[
"Get",
"a",
"list",
"of",
"module",
"files",
"for",
"a",
"filename",
"a",
"module",
"or",
"package",
"name",
"or",
"a",
"directory",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/i18n/pygettext.py#L353-L380
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/utils.py
|
unescape
|
def unescape(s):
"""The reverse function of `escape`. This unescapes all the HTML
entities, not only the XML entities inserted by `escape`.
:param s: the string to unescape.
"""
def handle_match(m):
name = m.group(1)
if name in HTMLBuilder._entities:
return unichr(HTMLBuilder._entities[name])
try:
if name[:2] in ('#x', '#X'):
return unichr(int(name[2:], 16))
elif name.startswith('#'):
return unichr(int(name[1:]))
except ValueError:
pass
return u''
return _entity_re.sub(handle_match, s)
|
python
|
def unescape(s):
"""The reverse function of `escape`. This unescapes all the HTML
entities, not only the XML entities inserted by `escape`.
:param s: the string to unescape.
"""
def handle_match(m):
name = m.group(1)
if name in HTMLBuilder._entities:
return unichr(HTMLBuilder._entities[name])
try:
if name[:2] in ('#x', '#X'):
return unichr(int(name[2:], 16))
elif name.startswith('#'):
return unichr(int(name[1:]))
except ValueError:
pass
return u''
return _entity_re.sub(handle_match, s)
|
[
"def",
"unescape",
"(",
"s",
")",
":",
"def",
"handle_match",
"(",
"m",
")",
":",
"name",
"=",
"m",
".",
"group",
"(",
"1",
")",
"if",
"name",
"in",
"HTMLBuilder",
".",
"_entities",
":",
"return",
"unichr",
"(",
"HTMLBuilder",
".",
"_entities",
"[",
"name",
"]",
")",
"try",
":",
"if",
"name",
"[",
":",
"2",
"]",
"in",
"(",
"'#x'",
",",
"'#X'",
")",
":",
"return",
"unichr",
"(",
"int",
"(",
"name",
"[",
"2",
":",
"]",
",",
"16",
")",
")",
"elif",
"name",
".",
"startswith",
"(",
"'#'",
")",
":",
"return",
"unichr",
"(",
"int",
"(",
"name",
"[",
"1",
":",
"]",
")",
")",
"except",
"ValueError",
":",
"pass",
"return",
"u''",
"return",
"_entity_re",
".",
"sub",
"(",
"handle_match",
",",
"s",
")"
] |
The reverse function of `escape`. This unescapes all the HTML
entities, not only the XML entities inserted by `escape`.
:param s: the string to unescape.
|
[
"The",
"reverse",
"function",
"of",
"escape",
".",
"This",
"unescapes",
"all",
"the",
"HTML",
"entities",
"not",
"only",
"the",
"XML",
"entities",
"inserted",
"by",
"escape",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/utils.py#L317-L335
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/utils.py
|
append_slash_redirect
|
def append_slash_redirect(environ, code=301):
"""Redirect to the same URL but with a slash appended. The behavior
of this function is undefined if the path ends with a slash already.
:param environ: the WSGI environment for the request that triggers
the redirect.
:param code: the status code for the redirect.
"""
new_path = environ['PATH_INFO'].strip('/') + '/'
query_string = environ.get('QUERY_STRING')
if query_string:
new_path += '?' + query_string
return redirect(new_path, code)
|
python
|
def append_slash_redirect(environ, code=301):
"""Redirect to the same URL but with a slash appended. The behavior
of this function is undefined if the path ends with a slash already.
:param environ: the WSGI environment for the request that triggers
the redirect.
:param code: the status code for the redirect.
"""
new_path = environ['PATH_INFO'].strip('/') + '/'
query_string = environ.get('QUERY_STRING')
if query_string:
new_path += '?' + query_string
return redirect(new_path, code)
|
[
"def",
"append_slash_redirect",
"(",
"environ",
",",
"code",
"=",
"301",
")",
":",
"new_path",
"=",
"environ",
"[",
"'PATH_INFO'",
"]",
".",
"strip",
"(",
"'/'",
")",
"+",
"'/'",
"query_string",
"=",
"environ",
".",
"get",
"(",
"'QUERY_STRING'",
")",
"if",
"query_string",
":",
"new_path",
"+=",
"'?'",
"+",
"query_string",
"return",
"redirect",
"(",
"new_path",
",",
"code",
")"
] |
Redirect to the same URL but with a slash appended. The behavior
of this function is undefined if the path ends with a slash already.
:param environ: the WSGI environment for the request that triggers
the redirect.
:param code: the status code for the redirect.
|
[
"Redirect",
"to",
"the",
"same",
"URL",
"but",
"with",
"a",
"slash",
"appended",
".",
"The",
"behavior",
"of",
"this",
"function",
"is",
"undefined",
"if",
"the",
"path",
"ends",
"with",
"a",
"slash",
"already",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/utils.py#L368-L380
|
train
|
limodou/uliweb
|
uliweb/i18n/po_merge.py
|
parse_translation
|
def parse_translation(f, lineno):
"""Read a single translation entry from the file F and return a
tuple with the comments, msgid and msgstr. The comments is returned
as a list of lines which do not end in new-lines. The msgid and
msgstr are strings, possibly with embedded newlines"""
line = f.readline()
def get_line(f, line, need_keys, lineno, default='""'):
line = line.rstrip()
if not line:
return lineno, need_keys[0], default, line
key, value = line.split(' ', 1)
# Parse msgid
if key not in need_keys:
print 'Error Line, need %r: %d, line=' % (need_keys, lineno, line)
raise RuntimeError("parse error")
v = value
while 1:
line = f.readline()
line = line.rstrip()
lineno += 1
if not line or line[0] != '"':
break
v += '\n' + line[:]
return lineno, key, v, line
# Parse comments
comments = []
while 1:
if not line:
return lineno, None, None, None
if line.strip() == '':
return lineno, comments, None, None
elif line[0] == '#':
comments.append(line[:-1])
else:
break
line = f.readline()
lineno += 1
lineno, key, msgid, line = get_line(f, line, ['msgid'], lineno)
lineno, key, value, line = get_line(f, line, ['msgid_plural', 'msgstr'], lineno)
if key == 'msgid_plural':
msgid = (msgid, value)
lineno, key, v1, line = get_line(f, line, ['msgstr[0]'], lineno)
lineno, key, v2, line = get_line(f, line, ['msgstr[1]'], lineno)
msgstr = (v1, v2)
else:
msgstr = value
if line != '':
print 'File: %s Error Line: %s' % (f.name, line)
raise RuntimeError("parse error")
return lineno, comments, msgid, msgstr
|
python
|
def parse_translation(f, lineno):
"""Read a single translation entry from the file F and return a
tuple with the comments, msgid and msgstr. The comments is returned
as a list of lines which do not end in new-lines. The msgid and
msgstr are strings, possibly with embedded newlines"""
line = f.readline()
def get_line(f, line, need_keys, lineno, default='""'):
line = line.rstrip()
if not line:
return lineno, need_keys[0], default, line
key, value = line.split(' ', 1)
# Parse msgid
if key not in need_keys:
print 'Error Line, need %r: %d, line=' % (need_keys, lineno, line)
raise RuntimeError("parse error")
v = value
while 1:
line = f.readline()
line = line.rstrip()
lineno += 1
if not line or line[0] != '"':
break
v += '\n' + line[:]
return lineno, key, v, line
# Parse comments
comments = []
while 1:
if not line:
return lineno, None, None, None
if line.strip() == '':
return lineno, comments, None, None
elif line[0] == '#':
comments.append(line[:-1])
else:
break
line = f.readline()
lineno += 1
lineno, key, msgid, line = get_line(f, line, ['msgid'], lineno)
lineno, key, value, line = get_line(f, line, ['msgid_plural', 'msgstr'], lineno)
if key == 'msgid_plural':
msgid = (msgid, value)
lineno, key, v1, line = get_line(f, line, ['msgstr[0]'], lineno)
lineno, key, v2, line = get_line(f, line, ['msgstr[1]'], lineno)
msgstr = (v1, v2)
else:
msgstr = value
if line != '':
print 'File: %s Error Line: %s' % (f.name, line)
raise RuntimeError("parse error")
return lineno, comments, msgid, msgstr
|
[
"def",
"parse_translation",
"(",
"f",
",",
"lineno",
")",
":",
"line",
"=",
"f",
".",
"readline",
"(",
")",
"def",
"get_line",
"(",
"f",
",",
"line",
",",
"need_keys",
",",
"lineno",
",",
"default",
"=",
"'\"\"'",
")",
":",
"line",
"=",
"line",
".",
"rstrip",
"(",
")",
"if",
"not",
"line",
":",
"return",
"lineno",
",",
"need_keys",
"[",
"0",
"]",
",",
"default",
",",
"line",
"key",
",",
"value",
"=",
"line",
".",
"split",
"(",
"' '",
",",
"1",
")",
"# Parse msgid\r",
"if",
"key",
"not",
"in",
"need_keys",
":",
"print",
"'Error Line, need %r: %d, line='",
"%",
"(",
"need_keys",
",",
"lineno",
",",
"line",
")",
"raise",
"RuntimeError",
"(",
"\"parse error\"",
")",
"v",
"=",
"value",
"while",
"1",
":",
"line",
"=",
"f",
".",
"readline",
"(",
")",
"line",
"=",
"line",
".",
"rstrip",
"(",
")",
"lineno",
"+=",
"1",
"if",
"not",
"line",
"or",
"line",
"[",
"0",
"]",
"!=",
"'\"'",
":",
"break",
"v",
"+=",
"'\\n'",
"+",
"line",
"[",
":",
"]",
"return",
"lineno",
",",
"key",
",",
"v",
",",
"line",
"# Parse comments\r",
"comments",
"=",
"[",
"]",
"while",
"1",
":",
"if",
"not",
"line",
":",
"return",
"lineno",
",",
"None",
",",
"None",
",",
"None",
"if",
"line",
".",
"strip",
"(",
")",
"==",
"''",
":",
"return",
"lineno",
",",
"comments",
",",
"None",
",",
"None",
"elif",
"line",
"[",
"0",
"]",
"==",
"'#'",
":",
"comments",
".",
"append",
"(",
"line",
"[",
":",
"-",
"1",
"]",
")",
"else",
":",
"break",
"line",
"=",
"f",
".",
"readline",
"(",
")",
"lineno",
"+=",
"1",
"lineno",
",",
"key",
",",
"msgid",
",",
"line",
"=",
"get_line",
"(",
"f",
",",
"line",
",",
"[",
"'msgid'",
"]",
",",
"lineno",
")",
"lineno",
",",
"key",
",",
"value",
",",
"line",
"=",
"get_line",
"(",
"f",
",",
"line",
",",
"[",
"'msgid_plural'",
",",
"'msgstr'",
"]",
",",
"lineno",
")",
"if",
"key",
"==",
"'msgid_plural'",
":",
"msgid",
"=",
"(",
"msgid",
",",
"value",
")",
"lineno",
",",
"key",
",",
"v1",
",",
"line",
"=",
"get_line",
"(",
"f",
",",
"line",
",",
"[",
"'msgstr[0]'",
"]",
",",
"lineno",
")",
"lineno",
",",
"key",
",",
"v2",
",",
"line",
"=",
"get_line",
"(",
"f",
",",
"line",
",",
"[",
"'msgstr[1]'",
"]",
",",
"lineno",
")",
"msgstr",
"=",
"(",
"v1",
",",
"v2",
")",
"else",
":",
"msgstr",
"=",
"value",
"if",
"line",
"!=",
"''",
":",
"print",
"'File: %s Error Line: %s'",
"%",
"(",
"f",
".",
"name",
",",
"line",
")",
"raise",
"RuntimeError",
"(",
"\"parse error\"",
")",
"return",
"lineno",
",",
"comments",
",",
"msgid",
",",
"msgstr"
] |
Read a single translation entry from the file F and return a
tuple with the comments, msgid and msgstr. The comments is returned
as a list of lines which do not end in new-lines. The msgid and
msgstr are strings, possibly with embedded newlines
|
[
"Read",
"a",
"single",
"translation",
"entry",
"from",
"the",
"file",
"F",
"and",
"return",
"a",
"tuple",
"with",
"the",
"comments",
"msgid",
"and",
"msgstr",
".",
"The",
"comments",
"is",
"returned",
"as",
"a",
"list",
"of",
"lines",
"which",
"do",
"not",
"end",
"in",
"new",
"-",
"lines",
".",
"The",
"msgid",
"and",
"msgstr",
"are",
"strings",
"possibly",
"with",
"embedded",
"newlines"
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/i18n/po_merge.py#L5-L59
|
train
|
limodou/uliweb
|
uliweb/contrib/form/__init__.py
|
get_form
|
def get_form(formcls):
"""
get form class according form class path or form class object
"""
from uliweb.form import Form
import inspect
if inspect.isclass(formcls) and issubclass(formcls, Form):
return formcls
elif isinstance(formcls, (str, unicode)):
path = settings.FORMS.get(formcls)
if path:
_cls = import_attr(path)
return _cls
else:
raise UliwebError("Can't find formcls name %s in settings.FORMS" % formcls)
else:
raise UliwebError("formcls should be Form class object or string path format, but %r found!" % formcls)
|
python
|
def get_form(formcls):
"""
get form class according form class path or form class object
"""
from uliweb.form import Form
import inspect
if inspect.isclass(formcls) and issubclass(formcls, Form):
return formcls
elif isinstance(formcls, (str, unicode)):
path = settings.FORMS.get(formcls)
if path:
_cls = import_attr(path)
return _cls
else:
raise UliwebError("Can't find formcls name %s in settings.FORMS" % formcls)
else:
raise UliwebError("formcls should be Form class object or string path format, but %r found!" % formcls)
|
[
"def",
"get_form",
"(",
"formcls",
")",
":",
"from",
"uliweb",
".",
"form",
"import",
"Form",
"import",
"inspect",
"if",
"inspect",
".",
"isclass",
"(",
"formcls",
")",
"and",
"issubclass",
"(",
"formcls",
",",
"Form",
")",
":",
"return",
"formcls",
"elif",
"isinstance",
"(",
"formcls",
",",
"(",
"str",
",",
"unicode",
")",
")",
":",
"path",
"=",
"settings",
".",
"FORMS",
".",
"get",
"(",
"formcls",
")",
"if",
"path",
":",
"_cls",
"=",
"import_attr",
"(",
"path",
")",
"return",
"_cls",
"else",
":",
"raise",
"UliwebError",
"(",
"\"Can't find formcls name %s in settings.FORMS\"",
"%",
"formcls",
")",
"else",
":",
"raise",
"UliwebError",
"(",
"\"formcls should be Form class object or string path format, but %r found!\"",
"%",
"formcls",
")"
] |
get form class according form class path or form class object
|
[
"get",
"form",
"class",
"according",
"form",
"class",
"path",
"or",
"form",
"class",
"object"
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/contrib/form/__init__.py#L6-L23
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/script.py
|
run
|
def run(namespace=None, action_prefix='action_', args=None):
"""Run the script. Participating actions are looked up in the caller's
namespace if no namespace is given, otherwise in the dict provided.
Only items that start with action_prefix are processed as actions. If
you want to use all items in the namespace provided as actions set
action_prefix to an empty string.
:param namespace: An optional dict where the functions are looked up in.
By default the local namespace of the caller is used.
:param action_prefix: The prefix for the functions. Everything else
is ignored.
:param args: the arguments for the function. If not specified
:data:`sys.argv` without the first argument is used.
"""
if namespace is None:
namespace = sys._getframe(1).f_locals
actions = find_actions(namespace, action_prefix)
if args is None:
args = sys.argv[1:]
if not args or args[0] in ('-h', '--help'):
return print_usage(actions)
elif args[0] not in actions:
fail('Unknown action \'%s\'' % args[0])
arguments = {}
types = {}
key_to_arg = {}
long_options = []
formatstring = ''
func, doc, arg_def = actions[args.pop(0)]
for idx, (arg, shortcut, default, option_type) in enumerate(arg_def):
real_arg = arg.replace('-', '_')
if shortcut:
formatstring += shortcut
if not isinstance(default, bool):
formatstring += ':'
key_to_arg['-' + shortcut] = real_arg
long_options.append(isinstance(default, bool) and arg or arg + '=')
key_to_arg['--' + arg] = real_arg
key_to_arg[idx] = real_arg
types[real_arg] = option_type
arguments[real_arg] = default
try:
optlist, posargs = getopt.gnu_getopt(args, formatstring, long_options)
except getopt.GetoptError as e:
fail(str(e))
specified_arguments = set()
for key, value in enumerate(posargs):
try:
arg = key_to_arg[key]
except IndexError:
fail('Too many parameters')
specified_arguments.add(arg)
try:
arguments[arg] = converters[types[arg]](value)
except ValueError:
fail('Invalid value for argument %s (%s): %s' % (key, arg, value))
for key, value in optlist:
arg = key_to_arg[key]
if arg in specified_arguments:
fail('Argument \'%s\' is specified twice' % arg)
if types[arg] == 'boolean':
if arg.startswith('no_'):
value = 'no'
else:
value = 'yes'
try:
arguments[arg] = converters[types[arg]](value)
except ValueError:
fail('Invalid value for \'%s\': %s' % (key, value))
newargs = {}
for k, v in iteritems(arguments):
newargs[k.startswith('no_') and k[3:] or k] = v
arguments = newargs
return func(**arguments)
|
python
|
def run(namespace=None, action_prefix='action_', args=None):
"""Run the script. Participating actions are looked up in the caller's
namespace if no namespace is given, otherwise in the dict provided.
Only items that start with action_prefix are processed as actions. If
you want to use all items in the namespace provided as actions set
action_prefix to an empty string.
:param namespace: An optional dict where the functions are looked up in.
By default the local namespace of the caller is used.
:param action_prefix: The prefix for the functions. Everything else
is ignored.
:param args: the arguments for the function. If not specified
:data:`sys.argv` without the first argument is used.
"""
if namespace is None:
namespace = sys._getframe(1).f_locals
actions = find_actions(namespace, action_prefix)
if args is None:
args = sys.argv[1:]
if not args or args[0] in ('-h', '--help'):
return print_usage(actions)
elif args[0] not in actions:
fail('Unknown action \'%s\'' % args[0])
arguments = {}
types = {}
key_to_arg = {}
long_options = []
formatstring = ''
func, doc, arg_def = actions[args.pop(0)]
for idx, (arg, shortcut, default, option_type) in enumerate(arg_def):
real_arg = arg.replace('-', '_')
if shortcut:
formatstring += shortcut
if not isinstance(default, bool):
formatstring += ':'
key_to_arg['-' + shortcut] = real_arg
long_options.append(isinstance(default, bool) and arg or arg + '=')
key_to_arg['--' + arg] = real_arg
key_to_arg[idx] = real_arg
types[real_arg] = option_type
arguments[real_arg] = default
try:
optlist, posargs = getopt.gnu_getopt(args, formatstring, long_options)
except getopt.GetoptError as e:
fail(str(e))
specified_arguments = set()
for key, value in enumerate(posargs):
try:
arg = key_to_arg[key]
except IndexError:
fail('Too many parameters')
specified_arguments.add(arg)
try:
arguments[arg] = converters[types[arg]](value)
except ValueError:
fail('Invalid value for argument %s (%s): %s' % (key, arg, value))
for key, value in optlist:
arg = key_to_arg[key]
if arg in specified_arguments:
fail('Argument \'%s\' is specified twice' % arg)
if types[arg] == 'boolean':
if arg.startswith('no_'):
value = 'no'
else:
value = 'yes'
try:
arguments[arg] = converters[types[arg]](value)
except ValueError:
fail('Invalid value for \'%s\': %s' % (key, value))
newargs = {}
for k, v in iteritems(arguments):
newargs[k.startswith('no_') and k[3:] or k] = v
arguments = newargs
return func(**arguments)
|
[
"def",
"run",
"(",
"namespace",
"=",
"None",
",",
"action_prefix",
"=",
"'action_'",
",",
"args",
"=",
"None",
")",
":",
"if",
"namespace",
"is",
"None",
":",
"namespace",
"=",
"sys",
".",
"_getframe",
"(",
"1",
")",
".",
"f_locals",
"actions",
"=",
"find_actions",
"(",
"namespace",
",",
"action_prefix",
")",
"if",
"args",
"is",
"None",
":",
"args",
"=",
"sys",
".",
"argv",
"[",
"1",
":",
"]",
"if",
"not",
"args",
"or",
"args",
"[",
"0",
"]",
"in",
"(",
"'-h'",
",",
"'--help'",
")",
":",
"return",
"print_usage",
"(",
"actions",
")",
"elif",
"args",
"[",
"0",
"]",
"not",
"in",
"actions",
":",
"fail",
"(",
"'Unknown action \\'%s\\''",
"%",
"args",
"[",
"0",
"]",
")",
"arguments",
"=",
"{",
"}",
"types",
"=",
"{",
"}",
"key_to_arg",
"=",
"{",
"}",
"long_options",
"=",
"[",
"]",
"formatstring",
"=",
"''",
"func",
",",
"doc",
",",
"arg_def",
"=",
"actions",
"[",
"args",
".",
"pop",
"(",
"0",
")",
"]",
"for",
"idx",
",",
"(",
"arg",
",",
"shortcut",
",",
"default",
",",
"option_type",
")",
"in",
"enumerate",
"(",
"arg_def",
")",
":",
"real_arg",
"=",
"arg",
".",
"replace",
"(",
"'-'",
",",
"'_'",
")",
"if",
"shortcut",
":",
"formatstring",
"+=",
"shortcut",
"if",
"not",
"isinstance",
"(",
"default",
",",
"bool",
")",
":",
"formatstring",
"+=",
"':'",
"key_to_arg",
"[",
"'-'",
"+",
"shortcut",
"]",
"=",
"real_arg",
"long_options",
".",
"append",
"(",
"isinstance",
"(",
"default",
",",
"bool",
")",
"and",
"arg",
"or",
"arg",
"+",
"'='",
")",
"key_to_arg",
"[",
"'--'",
"+",
"arg",
"]",
"=",
"real_arg",
"key_to_arg",
"[",
"idx",
"]",
"=",
"real_arg",
"types",
"[",
"real_arg",
"]",
"=",
"option_type",
"arguments",
"[",
"real_arg",
"]",
"=",
"default",
"try",
":",
"optlist",
",",
"posargs",
"=",
"getopt",
".",
"gnu_getopt",
"(",
"args",
",",
"formatstring",
",",
"long_options",
")",
"except",
"getopt",
".",
"GetoptError",
"as",
"e",
":",
"fail",
"(",
"str",
"(",
"e",
")",
")",
"specified_arguments",
"=",
"set",
"(",
")",
"for",
"key",
",",
"value",
"in",
"enumerate",
"(",
"posargs",
")",
":",
"try",
":",
"arg",
"=",
"key_to_arg",
"[",
"key",
"]",
"except",
"IndexError",
":",
"fail",
"(",
"'Too many parameters'",
")",
"specified_arguments",
".",
"add",
"(",
"arg",
")",
"try",
":",
"arguments",
"[",
"arg",
"]",
"=",
"converters",
"[",
"types",
"[",
"arg",
"]",
"]",
"(",
"value",
")",
"except",
"ValueError",
":",
"fail",
"(",
"'Invalid value for argument %s (%s): %s'",
"%",
"(",
"key",
",",
"arg",
",",
"value",
")",
")",
"for",
"key",
",",
"value",
"in",
"optlist",
":",
"arg",
"=",
"key_to_arg",
"[",
"key",
"]",
"if",
"arg",
"in",
"specified_arguments",
":",
"fail",
"(",
"'Argument \\'%s\\' is specified twice'",
"%",
"arg",
")",
"if",
"types",
"[",
"arg",
"]",
"==",
"'boolean'",
":",
"if",
"arg",
".",
"startswith",
"(",
"'no_'",
")",
":",
"value",
"=",
"'no'",
"else",
":",
"value",
"=",
"'yes'",
"try",
":",
"arguments",
"[",
"arg",
"]",
"=",
"converters",
"[",
"types",
"[",
"arg",
"]",
"]",
"(",
"value",
")",
"except",
"ValueError",
":",
"fail",
"(",
"'Invalid value for \\'%s\\': %s'",
"%",
"(",
"key",
",",
"value",
")",
")",
"newargs",
"=",
"{",
"}",
"for",
"k",
",",
"v",
"in",
"iteritems",
"(",
"arguments",
")",
":",
"newargs",
"[",
"k",
".",
"startswith",
"(",
"'no_'",
")",
"and",
"k",
"[",
"3",
":",
"]",
"or",
"k",
"]",
"=",
"v",
"arguments",
"=",
"newargs",
"return",
"func",
"(",
"*",
"*",
"arguments",
")"
] |
Run the script. Participating actions are looked up in the caller's
namespace if no namespace is given, otherwise in the dict provided.
Only items that start with action_prefix are processed as actions. If
you want to use all items in the namespace provided as actions set
action_prefix to an empty string.
:param namespace: An optional dict where the functions are looked up in.
By default the local namespace of the caller is used.
:param action_prefix: The prefix for the functions. Everything else
is ignored.
:param args: the arguments for the function. If not specified
:data:`sys.argv` without the first argument is used.
|
[
"Run",
"the",
"script",
".",
"Participating",
"actions",
"are",
"looked",
"up",
"in",
"the",
"caller",
"s",
"namespace",
"if",
"no",
"namespace",
"is",
"given",
"otherwise",
"in",
"the",
"dict",
"provided",
".",
"Only",
"items",
"that",
"start",
"with",
"action_prefix",
"are",
"processed",
"as",
"actions",
".",
"If",
"you",
"want",
"to",
"use",
"all",
"items",
"in",
"the",
"namespace",
"provided",
"as",
"actions",
"set",
"action_prefix",
"to",
"an",
"empty",
"string",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/script.py#L98-L177
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/script.py
|
fail
|
def fail(message, code=-1):
"""Fail with an error."""
print('Error: %s' % message, file=sys.stderr)
sys.exit(code)
|
python
|
def fail(message, code=-1):
"""Fail with an error."""
print('Error: %s' % message, file=sys.stderr)
sys.exit(code)
|
[
"def",
"fail",
"(",
"message",
",",
"code",
"=",
"-",
"1",
")",
":",
"print",
"(",
"'Error: %s'",
"%",
"message",
",",
"file",
"=",
"sys",
".",
"stderr",
")",
"sys",
".",
"exit",
"(",
"code",
")"
] |
Fail with an error.
|
[
"Fail",
"with",
"an",
"error",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/script.py#L180-L183
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/script.py
|
find_actions
|
def find_actions(namespace, action_prefix):
"""Find all the actions in the namespace."""
actions = {}
for key, value in iteritems(namespace):
if key.startswith(action_prefix):
actions[key[len(action_prefix):]] = analyse_action(value)
return actions
|
python
|
def find_actions(namespace, action_prefix):
"""Find all the actions in the namespace."""
actions = {}
for key, value in iteritems(namespace):
if key.startswith(action_prefix):
actions[key[len(action_prefix):]] = analyse_action(value)
return actions
|
[
"def",
"find_actions",
"(",
"namespace",
",",
"action_prefix",
")",
":",
"actions",
"=",
"{",
"}",
"for",
"key",
",",
"value",
"in",
"iteritems",
"(",
"namespace",
")",
":",
"if",
"key",
".",
"startswith",
"(",
"action_prefix",
")",
":",
"actions",
"[",
"key",
"[",
"len",
"(",
"action_prefix",
")",
":",
"]",
"]",
"=",
"analyse_action",
"(",
"value",
")",
"return",
"actions"
] |
Find all the actions in the namespace.
|
[
"Find",
"all",
"the",
"actions",
"in",
"the",
"namespace",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/script.py#L186-L192
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/script.py
|
analyse_action
|
def analyse_action(func):
"""Analyse a function."""
description = inspect.getdoc(func) or 'undocumented action'
arguments = []
args, varargs, kwargs, defaults = inspect.getargspec(func)
if varargs or kwargs:
raise TypeError('variable length arguments for action not allowed.')
if len(args) != len(defaults or ()):
raise TypeError('not all arguments have proper definitions')
for idx, (arg, definition) in enumerate(zip(args, defaults or ())):
if arg.startswith('_'):
raise TypeError('arguments may not start with an underscore')
if not isinstance(definition, tuple):
shortcut = None
default = definition
else:
shortcut, default = definition
argument_type = argument_types[type(default)]
if isinstance(default, bool) and default is True:
arg = 'no-' + arg
arguments.append((arg.replace('_', '-'), shortcut,
default, argument_type))
return func, description, arguments
|
python
|
def analyse_action(func):
"""Analyse a function."""
description = inspect.getdoc(func) or 'undocumented action'
arguments = []
args, varargs, kwargs, defaults = inspect.getargspec(func)
if varargs or kwargs:
raise TypeError('variable length arguments for action not allowed.')
if len(args) != len(defaults or ()):
raise TypeError('not all arguments have proper definitions')
for idx, (arg, definition) in enumerate(zip(args, defaults or ())):
if arg.startswith('_'):
raise TypeError('arguments may not start with an underscore')
if not isinstance(definition, tuple):
shortcut = None
default = definition
else:
shortcut, default = definition
argument_type = argument_types[type(default)]
if isinstance(default, bool) and default is True:
arg = 'no-' + arg
arguments.append((arg.replace('_', '-'), shortcut,
default, argument_type))
return func, description, arguments
|
[
"def",
"analyse_action",
"(",
"func",
")",
":",
"description",
"=",
"inspect",
".",
"getdoc",
"(",
"func",
")",
"or",
"'undocumented action'",
"arguments",
"=",
"[",
"]",
"args",
",",
"varargs",
",",
"kwargs",
",",
"defaults",
"=",
"inspect",
".",
"getargspec",
"(",
"func",
")",
"if",
"varargs",
"or",
"kwargs",
":",
"raise",
"TypeError",
"(",
"'variable length arguments for action not allowed.'",
")",
"if",
"len",
"(",
"args",
")",
"!=",
"len",
"(",
"defaults",
"or",
"(",
")",
")",
":",
"raise",
"TypeError",
"(",
"'not all arguments have proper definitions'",
")",
"for",
"idx",
",",
"(",
"arg",
",",
"definition",
")",
"in",
"enumerate",
"(",
"zip",
"(",
"args",
",",
"defaults",
"or",
"(",
")",
")",
")",
":",
"if",
"arg",
".",
"startswith",
"(",
"'_'",
")",
":",
"raise",
"TypeError",
"(",
"'arguments may not start with an underscore'",
")",
"if",
"not",
"isinstance",
"(",
"definition",
",",
"tuple",
")",
":",
"shortcut",
"=",
"None",
"default",
"=",
"definition",
"else",
":",
"shortcut",
",",
"default",
"=",
"definition",
"argument_type",
"=",
"argument_types",
"[",
"type",
"(",
"default",
")",
"]",
"if",
"isinstance",
"(",
"default",
",",
"bool",
")",
"and",
"default",
"is",
"True",
":",
"arg",
"=",
"'no-'",
"+",
"arg",
"arguments",
".",
"append",
"(",
"(",
"arg",
".",
"replace",
"(",
"'_'",
",",
"'-'",
")",
",",
"shortcut",
",",
"default",
",",
"argument_type",
")",
")",
"return",
"func",
",",
"description",
",",
"arguments"
] |
Analyse a function.
|
[
"Analyse",
"a",
"function",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/script.py#L222-L245
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/script.py
|
make_shell
|
def make_shell(init_func=None, banner=None, use_ipython=True):
"""Returns an action callback that spawns a new interactive
python shell.
:param init_func: an optional initialization function that is
called before the shell is started. The return
value of this function is the initial namespace.
:param banner: the banner that is displayed before the shell. If
not specified a generic banner is used instead.
:param use_ipython: if set to `True` ipython is used if available.
"""
if banner is None:
banner = 'Interactive Werkzeug Shell'
if init_func is None:
init_func = dict
def action(ipython=use_ipython):
"""Start a new interactive python session."""
namespace = init_func()
if ipython:
try:
try:
from IPython.frontend.terminal.embed import InteractiveShellEmbed
sh = InteractiveShellEmbed(banner1=banner)
except ImportError:
from IPython.Shell import IPShellEmbed
sh = IPShellEmbed(banner=banner)
except ImportError:
pass
else:
sh(global_ns={}, local_ns=namespace)
return
from code import interact
interact(banner, local=namespace)
return action
|
python
|
def make_shell(init_func=None, banner=None, use_ipython=True):
"""Returns an action callback that spawns a new interactive
python shell.
:param init_func: an optional initialization function that is
called before the shell is started. The return
value of this function is the initial namespace.
:param banner: the banner that is displayed before the shell. If
not specified a generic banner is used instead.
:param use_ipython: if set to `True` ipython is used if available.
"""
if banner is None:
banner = 'Interactive Werkzeug Shell'
if init_func is None:
init_func = dict
def action(ipython=use_ipython):
"""Start a new interactive python session."""
namespace = init_func()
if ipython:
try:
try:
from IPython.frontend.terminal.embed import InteractiveShellEmbed
sh = InteractiveShellEmbed(banner1=banner)
except ImportError:
from IPython.Shell import IPShellEmbed
sh = IPShellEmbed(banner=banner)
except ImportError:
pass
else:
sh(global_ns={}, local_ns=namespace)
return
from code import interact
interact(banner, local=namespace)
return action
|
[
"def",
"make_shell",
"(",
"init_func",
"=",
"None",
",",
"banner",
"=",
"None",
",",
"use_ipython",
"=",
"True",
")",
":",
"if",
"banner",
"is",
"None",
":",
"banner",
"=",
"'Interactive Werkzeug Shell'",
"if",
"init_func",
"is",
"None",
":",
"init_func",
"=",
"dict",
"def",
"action",
"(",
"ipython",
"=",
"use_ipython",
")",
":",
"\"\"\"Start a new interactive python session.\"\"\"",
"namespace",
"=",
"init_func",
"(",
")",
"if",
"ipython",
":",
"try",
":",
"try",
":",
"from",
"IPython",
".",
"frontend",
".",
"terminal",
".",
"embed",
"import",
"InteractiveShellEmbed",
"sh",
"=",
"InteractiveShellEmbed",
"(",
"banner1",
"=",
"banner",
")",
"except",
"ImportError",
":",
"from",
"IPython",
".",
"Shell",
"import",
"IPShellEmbed",
"sh",
"=",
"IPShellEmbed",
"(",
"banner",
"=",
"banner",
")",
"except",
"ImportError",
":",
"pass",
"else",
":",
"sh",
"(",
"global_ns",
"=",
"{",
"}",
",",
"local_ns",
"=",
"namespace",
")",
"return",
"from",
"code",
"import",
"interact",
"interact",
"(",
"banner",
",",
"local",
"=",
"namespace",
")",
"return",
"action"
] |
Returns an action callback that spawns a new interactive
python shell.
:param init_func: an optional initialization function that is
called before the shell is started. The return
value of this function is the initial namespace.
:param banner: the banner that is displayed before the shell. If
not specified a generic banner is used instead.
:param use_ipython: if set to `True` ipython is used if available.
|
[
"Returns",
"an",
"action",
"callback",
"that",
"spawns",
"a",
"new",
"interactive",
"python",
"shell",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/script.py#L248-L281
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/script.py
|
make_runserver
|
def make_runserver(app_factory, hostname='localhost', port=5000,
use_reloader=False, use_debugger=False, use_evalex=True,
threaded=False, processes=1, static_files=None,
extra_files=None, ssl_context=None):
"""Returns an action callback that spawns a new development server.
.. versionadded:: 0.5
`static_files` and `extra_files` was added.
..versionadded:: 0.6.1
`ssl_context` was added.
:param app_factory: a function that returns a new WSGI application.
:param hostname: the default hostname the server should listen on.
:param port: the default port of the server.
:param use_reloader: the default setting for the reloader.
:param use_evalex: the default setting for the evalex flag of the debugger.
:param threaded: the default threading setting.
:param processes: the default number of processes to start.
:param static_files: optional dict of static files.
:param extra_files: optional list of extra files to track for reloading.
:param ssl_context: optional SSL context for running server in HTTPS mode.
"""
def action(hostname=('h', hostname), port=('p', port),
reloader=use_reloader, debugger=use_debugger,
evalex=use_evalex, threaded=threaded, processes=processes):
"""Start a new development server."""
from werkzeug.serving import run_simple
app = app_factory()
run_simple(hostname, port, app, reloader, debugger, evalex,
extra_files, 1, threaded, processes,
static_files=static_files, ssl_context=ssl_context)
return action
|
python
|
def make_runserver(app_factory, hostname='localhost', port=5000,
use_reloader=False, use_debugger=False, use_evalex=True,
threaded=False, processes=1, static_files=None,
extra_files=None, ssl_context=None):
"""Returns an action callback that spawns a new development server.
.. versionadded:: 0.5
`static_files` and `extra_files` was added.
..versionadded:: 0.6.1
`ssl_context` was added.
:param app_factory: a function that returns a new WSGI application.
:param hostname: the default hostname the server should listen on.
:param port: the default port of the server.
:param use_reloader: the default setting for the reloader.
:param use_evalex: the default setting for the evalex flag of the debugger.
:param threaded: the default threading setting.
:param processes: the default number of processes to start.
:param static_files: optional dict of static files.
:param extra_files: optional list of extra files to track for reloading.
:param ssl_context: optional SSL context for running server in HTTPS mode.
"""
def action(hostname=('h', hostname), port=('p', port),
reloader=use_reloader, debugger=use_debugger,
evalex=use_evalex, threaded=threaded, processes=processes):
"""Start a new development server."""
from werkzeug.serving import run_simple
app = app_factory()
run_simple(hostname, port, app, reloader, debugger, evalex,
extra_files, 1, threaded, processes,
static_files=static_files, ssl_context=ssl_context)
return action
|
[
"def",
"make_runserver",
"(",
"app_factory",
",",
"hostname",
"=",
"'localhost'",
",",
"port",
"=",
"5000",
",",
"use_reloader",
"=",
"False",
",",
"use_debugger",
"=",
"False",
",",
"use_evalex",
"=",
"True",
",",
"threaded",
"=",
"False",
",",
"processes",
"=",
"1",
",",
"static_files",
"=",
"None",
",",
"extra_files",
"=",
"None",
",",
"ssl_context",
"=",
"None",
")",
":",
"def",
"action",
"(",
"hostname",
"=",
"(",
"'h'",
",",
"hostname",
")",
",",
"port",
"=",
"(",
"'p'",
",",
"port",
")",
",",
"reloader",
"=",
"use_reloader",
",",
"debugger",
"=",
"use_debugger",
",",
"evalex",
"=",
"use_evalex",
",",
"threaded",
"=",
"threaded",
",",
"processes",
"=",
"processes",
")",
":",
"\"\"\"Start a new development server.\"\"\"",
"from",
"werkzeug",
".",
"serving",
"import",
"run_simple",
"app",
"=",
"app_factory",
"(",
")",
"run_simple",
"(",
"hostname",
",",
"port",
",",
"app",
",",
"reloader",
",",
"debugger",
",",
"evalex",
",",
"extra_files",
",",
"1",
",",
"threaded",
",",
"processes",
",",
"static_files",
"=",
"static_files",
",",
"ssl_context",
"=",
"ssl_context",
")",
"return",
"action"
] |
Returns an action callback that spawns a new development server.
.. versionadded:: 0.5
`static_files` and `extra_files` was added.
..versionadded:: 0.6.1
`ssl_context` was added.
:param app_factory: a function that returns a new WSGI application.
:param hostname: the default hostname the server should listen on.
:param port: the default port of the server.
:param use_reloader: the default setting for the reloader.
:param use_evalex: the default setting for the evalex flag of the debugger.
:param threaded: the default threading setting.
:param processes: the default number of processes to start.
:param static_files: optional dict of static files.
:param extra_files: optional list of extra files to track for reloading.
:param ssl_context: optional SSL context for running server in HTTPS mode.
|
[
"Returns",
"an",
"action",
"callback",
"that",
"spawns",
"a",
"new",
"development",
"server",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/script.py#L284-L316
|
train
|
limodou/uliweb
|
uliweb/core/dispatch.py
|
unbind
|
def unbind(topic, func):
"""
Remove receiver function
"""
if topic in _receivers:
receivers = _receivers[topic]
for i in range(len(receivers)-1, -1, -1):
nice, f = receivers[i]
if (callable(func) and f['func'] == func) or (f['func_name'] == func):
del receivers[i]
return
|
python
|
def unbind(topic, func):
"""
Remove receiver function
"""
if topic in _receivers:
receivers = _receivers[topic]
for i in range(len(receivers)-1, -1, -1):
nice, f = receivers[i]
if (callable(func) and f['func'] == func) or (f['func_name'] == func):
del receivers[i]
return
|
[
"def",
"unbind",
"(",
"topic",
",",
"func",
")",
":",
"if",
"topic",
"in",
"_receivers",
":",
"receivers",
"=",
"_receivers",
"[",
"topic",
"]",
"for",
"i",
"in",
"range",
"(",
"len",
"(",
"receivers",
")",
"-",
"1",
",",
"-",
"1",
",",
"-",
"1",
")",
":",
"nice",
",",
"f",
"=",
"receivers",
"[",
"i",
"]",
"if",
"(",
"callable",
"(",
"func",
")",
"and",
"f",
"[",
"'func'",
"]",
"==",
"func",
")",
"or",
"(",
"f",
"[",
"'func_name'",
"]",
"==",
"func",
")",
":",
"del",
"receivers",
"[",
"i",
"]",
"return"
] |
Remove receiver function
|
[
"Remove",
"receiver",
"function"
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/core/dispatch.py#L54-L64
|
train
|
limodou/uliweb
|
uliweb/core/dispatch.py
|
call
|
def call(sender, topic, *args, **kwargs):
"""
Invoke receiver functions according topic, it'll invoke receiver functions one by one,
and it'll not return anything, so if you want to return a value, you should
use get function.
"""
if not topic in _receivers:
return
items = _receivers[topic]
def _cmp(x, y):
return cmp(x[0], y[0])
items.sort(_cmp)
i = 0
while i<len(items):
nice, f = items[i]
i = i + 1
_f = f['func']
if not _f:
try:
_f = import_attr(f['func_name'])
except (ImportError, AttributeError) as e:
logging.error("Can't import function %s" % f['func_name'])
raise
f['func'] = _f
if callable(_f):
kw = kwargs.copy()
if not _test(kw, f):
continue
try:
_f(sender, *args, **kw)
except:
func = _f.__module__ + '.' + _f.__name__
logging.exception('Calling dispatch point [%s] %s(%r, %r) error!' % (topic, func, args, kw))
raise
else:
raise Exception, "Dispatch point [%s] %r can't been invoked" % (topic, _f)
|
python
|
def call(sender, topic, *args, **kwargs):
"""
Invoke receiver functions according topic, it'll invoke receiver functions one by one,
and it'll not return anything, so if you want to return a value, you should
use get function.
"""
if not topic in _receivers:
return
items = _receivers[topic]
def _cmp(x, y):
return cmp(x[0], y[0])
items.sort(_cmp)
i = 0
while i<len(items):
nice, f = items[i]
i = i + 1
_f = f['func']
if not _f:
try:
_f = import_attr(f['func_name'])
except (ImportError, AttributeError) as e:
logging.error("Can't import function %s" % f['func_name'])
raise
f['func'] = _f
if callable(_f):
kw = kwargs.copy()
if not _test(kw, f):
continue
try:
_f(sender, *args, **kw)
except:
func = _f.__module__ + '.' + _f.__name__
logging.exception('Calling dispatch point [%s] %s(%r, %r) error!' % (topic, func, args, kw))
raise
else:
raise Exception, "Dispatch point [%s] %r can't been invoked" % (topic, _f)
|
[
"def",
"call",
"(",
"sender",
",",
"topic",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"not",
"topic",
"in",
"_receivers",
":",
"return",
"items",
"=",
"_receivers",
"[",
"topic",
"]",
"def",
"_cmp",
"(",
"x",
",",
"y",
")",
":",
"return",
"cmp",
"(",
"x",
"[",
"0",
"]",
",",
"y",
"[",
"0",
"]",
")",
"items",
".",
"sort",
"(",
"_cmp",
")",
"i",
"=",
"0",
"while",
"i",
"<",
"len",
"(",
"items",
")",
":",
"nice",
",",
"f",
"=",
"items",
"[",
"i",
"]",
"i",
"=",
"i",
"+",
"1",
"_f",
"=",
"f",
"[",
"'func'",
"]",
"if",
"not",
"_f",
":",
"try",
":",
"_f",
"=",
"import_attr",
"(",
"f",
"[",
"'func_name'",
"]",
")",
"except",
"(",
"ImportError",
",",
"AttributeError",
")",
"as",
"e",
":",
"logging",
".",
"error",
"(",
"\"Can't import function %s\"",
"%",
"f",
"[",
"'func_name'",
"]",
")",
"raise",
"f",
"[",
"'func'",
"]",
"=",
"_f",
"if",
"callable",
"(",
"_f",
")",
":",
"kw",
"=",
"kwargs",
".",
"copy",
"(",
")",
"if",
"not",
"_test",
"(",
"kw",
",",
"f",
")",
":",
"continue",
"try",
":",
"_f",
"(",
"sender",
",",
"*",
"args",
",",
"*",
"*",
"kw",
")",
"except",
":",
"func",
"=",
"_f",
".",
"__module__",
"+",
"'.'",
"+",
"_f",
".",
"__name__",
"logging",
".",
"exception",
"(",
"'Calling dispatch point [%s] %s(%r, %r) error!'",
"%",
"(",
"topic",
",",
"func",
",",
"args",
",",
"kw",
")",
")",
"raise",
"else",
":",
"raise",
"Exception",
",",
"\"Dispatch point [%s] %r can't been invoked\"",
"%",
"(",
"topic",
",",
"_f",
")"
] |
Invoke receiver functions according topic, it'll invoke receiver functions one by one,
and it'll not return anything, so if you want to return a value, you should
use get function.
|
[
"Invoke",
"receiver",
"functions",
"according",
"topic",
"it",
"ll",
"invoke",
"receiver",
"functions",
"one",
"by",
"one",
"and",
"it",
"ll",
"not",
"return",
"anything",
"so",
"if",
"you",
"want",
"to",
"return",
"a",
"value",
"you",
"should",
"use",
"get",
"function",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/core/dispatch.py#L82-L118
|
train
|
limodou/uliweb
|
uliweb/core/dispatch.py
|
get
|
def get(sender, topic, *args, **kwargs):
"""
Invoke receiver functions according topic, it'll invoke receiver functions one by one,
and if one receiver function return non-None value, it'll return it and break
the loop.
"""
if not topic in _receivers:
return
items = _receivers[topic]
def _cmp(x, y):
return cmp(x[0], y[0])
items.sort(_cmp)
for i in range(len(items)):
nice, f = items[i]
_f = f['func']
if not _f:
try:
_f = import_attr(f['func_name'])
except ImportError:
logging.error("Can't import function %s" % f['func_name'])
raise
f['func'] = _f
if callable(_f):
if not _test(kwargs, f):
continue
try:
v = _f(sender, *args, **kwargs)
except:
func = _f.__module__ + '.' + _f.__name__
logging.exception('Calling dispatch point [%s] %s(%r,%r) error!' % (topic, func, args, kwargs))
raise
if v is not None:
return v
else:
raise "Dispatch point [%s] %r can't been invoked" % (topic, _f)
|
python
|
def get(sender, topic, *args, **kwargs):
"""
Invoke receiver functions according topic, it'll invoke receiver functions one by one,
and if one receiver function return non-None value, it'll return it and break
the loop.
"""
if not topic in _receivers:
return
items = _receivers[topic]
def _cmp(x, y):
return cmp(x[0], y[0])
items.sort(_cmp)
for i in range(len(items)):
nice, f = items[i]
_f = f['func']
if not _f:
try:
_f = import_attr(f['func_name'])
except ImportError:
logging.error("Can't import function %s" % f['func_name'])
raise
f['func'] = _f
if callable(_f):
if not _test(kwargs, f):
continue
try:
v = _f(sender, *args, **kwargs)
except:
func = _f.__module__ + '.' + _f.__name__
logging.exception('Calling dispatch point [%s] %s(%r,%r) error!' % (topic, func, args, kwargs))
raise
if v is not None:
return v
else:
raise "Dispatch point [%s] %r can't been invoked" % (topic, _f)
|
[
"def",
"get",
"(",
"sender",
",",
"topic",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"not",
"topic",
"in",
"_receivers",
":",
"return",
"items",
"=",
"_receivers",
"[",
"topic",
"]",
"def",
"_cmp",
"(",
"x",
",",
"y",
")",
":",
"return",
"cmp",
"(",
"x",
"[",
"0",
"]",
",",
"y",
"[",
"0",
"]",
")",
"items",
".",
"sort",
"(",
"_cmp",
")",
"for",
"i",
"in",
"range",
"(",
"len",
"(",
"items",
")",
")",
":",
"nice",
",",
"f",
"=",
"items",
"[",
"i",
"]",
"_f",
"=",
"f",
"[",
"'func'",
"]",
"if",
"not",
"_f",
":",
"try",
":",
"_f",
"=",
"import_attr",
"(",
"f",
"[",
"'func_name'",
"]",
")",
"except",
"ImportError",
":",
"logging",
".",
"error",
"(",
"\"Can't import function %s\"",
"%",
"f",
"[",
"'func_name'",
"]",
")",
"raise",
"f",
"[",
"'func'",
"]",
"=",
"_f",
"if",
"callable",
"(",
"_f",
")",
":",
"if",
"not",
"_test",
"(",
"kwargs",
",",
"f",
")",
":",
"continue",
"try",
":",
"v",
"=",
"_f",
"(",
"sender",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"except",
":",
"func",
"=",
"_f",
".",
"__module__",
"+",
"'.'",
"+",
"_f",
".",
"__name__",
"logging",
".",
"exception",
"(",
"'Calling dispatch point [%s] %s(%r,%r) error!'",
"%",
"(",
"topic",
",",
"func",
",",
"args",
",",
"kwargs",
")",
")",
"raise",
"if",
"v",
"is",
"not",
"None",
":",
"return",
"v",
"else",
":",
"raise",
"\"Dispatch point [%s] %r can't been invoked\"",
"%",
"(",
"topic",
",",
"_f",
")"
] |
Invoke receiver functions according topic, it'll invoke receiver functions one by one,
and if one receiver function return non-None value, it'll return it and break
the loop.
|
[
"Invoke",
"receiver",
"functions",
"according",
"topic",
"it",
"ll",
"invoke",
"receiver",
"functions",
"one",
"by",
"one",
"and",
"if",
"one",
"receiver",
"function",
"return",
"non",
"-",
"None",
"value",
"it",
"ll",
"return",
"it",
"and",
"break",
"the",
"loop",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/core/dispatch.py#L128-L163
|
train
|
limodou/uliweb
|
uliweb/utils/pyini.py
|
Ini.__read_line
|
def __read_line(self, f):
"""
Get logic line according the syntax not the physical line
It'll return the line text and if there is identifier existed
return line, bool
"""
g = tokenize.generate_tokens(f.readline)
buf = []
time = 0
iden_existed = False
while 1:
v = g.next()
tokentype, t, start, end, line = v
if tokentype == 54:
continue
if tokentype in (token.INDENT, token.DEDENT, tokenize.COMMENT):
continue
if tokentype == token.NAME:
iden_existed = True
if tokentype == token.NEWLINE:
return ''.join(buf), iden_existed
else:
if t == '=' and time == 0:
time += 1
continue
buf.append(t)
|
python
|
def __read_line(self, f):
"""
Get logic line according the syntax not the physical line
It'll return the line text and if there is identifier existed
return line, bool
"""
g = tokenize.generate_tokens(f.readline)
buf = []
time = 0
iden_existed = False
while 1:
v = g.next()
tokentype, t, start, end, line = v
if tokentype == 54:
continue
if tokentype in (token.INDENT, token.DEDENT, tokenize.COMMENT):
continue
if tokentype == token.NAME:
iden_existed = True
if tokentype == token.NEWLINE:
return ''.join(buf), iden_existed
else:
if t == '=' and time == 0:
time += 1
continue
buf.append(t)
|
[
"def",
"__read_line",
"(",
"self",
",",
"f",
")",
":",
"g",
"=",
"tokenize",
".",
"generate_tokens",
"(",
"f",
".",
"readline",
")",
"buf",
"=",
"[",
"]",
"time",
"=",
"0",
"iden_existed",
"=",
"False",
"while",
"1",
":",
"v",
"=",
"g",
".",
"next",
"(",
")",
"tokentype",
",",
"t",
",",
"start",
",",
"end",
",",
"line",
"=",
"v",
"if",
"tokentype",
"==",
"54",
":",
"continue",
"if",
"tokentype",
"in",
"(",
"token",
".",
"INDENT",
",",
"token",
".",
"DEDENT",
",",
"tokenize",
".",
"COMMENT",
")",
":",
"continue",
"if",
"tokentype",
"==",
"token",
".",
"NAME",
":",
"iden_existed",
"=",
"True",
"if",
"tokentype",
"==",
"token",
".",
"NEWLINE",
":",
"return",
"''",
".",
"join",
"(",
"buf",
")",
",",
"iden_existed",
"else",
":",
"if",
"t",
"==",
"'='",
"and",
"time",
"==",
"0",
":",
"time",
"+=",
"1",
"continue",
"buf",
".",
"append",
"(",
"t",
")"
] |
Get logic line according the syntax not the physical line
It'll return the line text and if there is identifier existed
return line, bool
|
[
"Get",
"logic",
"line",
"according",
"the",
"syntax",
"not",
"the",
"physical",
"line",
"It",
"ll",
"return",
"the",
"line",
"text",
"and",
"if",
"there",
"is",
"identifier",
"existed",
"return",
"line",
"bool"
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/utils/pyini.py#L611-L638
|
train
|
limodou/uliweb
|
uliweb/utils/pyini.py
|
Ini.freeze
|
def freeze(self):
"""
Process all EvalValue to real value
"""
self._lazy = False
for k, v in self.items():
if k in self._env:
continue
for _k, _v in v.items():
if isinstance(_v, Lazy):
if self.writable:
_v.get()
else:
try:
v.__setitem__(_k, _v.get(), replace=True)
except:
print "Error ini key:", _k
raise
del _v
self._globals = SortedDict()
|
python
|
def freeze(self):
"""
Process all EvalValue to real value
"""
self._lazy = False
for k, v in self.items():
if k in self._env:
continue
for _k, _v in v.items():
if isinstance(_v, Lazy):
if self.writable:
_v.get()
else:
try:
v.__setitem__(_k, _v.get(), replace=True)
except:
print "Error ini key:", _k
raise
del _v
self._globals = SortedDict()
|
[
"def",
"freeze",
"(",
"self",
")",
":",
"self",
".",
"_lazy",
"=",
"False",
"for",
"k",
",",
"v",
"in",
"self",
".",
"items",
"(",
")",
":",
"if",
"k",
"in",
"self",
".",
"_env",
":",
"continue",
"for",
"_k",
",",
"_v",
"in",
"v",
".",
"items",
"(",
")",
":",
"if",
"isinstance",
"(",
"_v",
",",
"Lazy",
")",
":",
"if",
"self",
".",
"writable",
":",
"_v",
".",
"get",
"(",
")",
"else",
":",
"try",
":",
"v",
".",
"__setitem__",
"(",
"_k",
",",
"_v",
".",
"get",
"(",
")",
",",
"replace",
"=",
"True",
")",
"except",
":",
"print",
"\"Error ini key:\"",
",",
"_k",
"raise",
"del",
"_v",
"self",
".",
"_globals",
"=",
"SortedDict",
"(",
")"
] |
Process all EvalValue to real value
|
[
"Process",
"all",
"EvalValue",
"to",
"real",
"value"
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/utils/pyini.py#L708-L727
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/contrib/securecookie.py
|
SecureCookie.serialize
|
def serialize(self, expires=None):
"""Serialize the secure cookie into a string.
If expires is provided, the session will be automatically invalidated
after expiration when you unseralize it. This provides better
protection against session cookie theft.
:param expires: an optional expiration date for the cookie (a
:class:`datetime.datetime` object)
"""
if self.secret_key is None:
raise RuntimeError('no secret key defined')
if expires:
self['_expires'] = _date_to_unix(expires)
result = []
mac = hmac(self.secret_key, None, self.hash_method)
for key, value in sorted(self.items()):
result.append(('%s=%s' % (
url_quote_plus(key),
self.quote(value).decode('ascii')
)).encode('ascii'))
mac.update(b'|' + result[-1])
return b'?'.join([
base64.b64encode(mac.digest()).strip(),
b'&'.join(result)
])
|
python
|
def serialize(self, expires=None):
"""Serialize the secure cookie into a string.
If expires is provided, the session will be automatically invalidated
after expiration when you unseralize it. This provides better
protection against session cookie theft.
:param expires: an optional expiration date for the cookie (a
:class:`datetime.datetime` object)
"""
if self.secret_key is None:
raise RuntimeError('no secret key defined')
if expires:
self['_expires'] = _date_to_unix(expires)
result = []
mac = hmac(self.secret_key, None, self.hash_method)
for key, value in sorted(self.items()):
result.append(('%s=%s' % (
url_quote_plus(key),
self.quote(value).decode('ascii')
)).encode('ascii'))
mac.update(b'|' + result[-1])
return b'?'.join([
base64.b64encode(mac.digest()).strip(),
b'&'.join(result)
])
|
[
"def",
"serialize",
"(",
"self",
",",
"expires",
"=",
"None",
")",
":",
"if",
"self",
".",
"secret_key",
"is",
"None",
":",
"raise",
"RuntimeError",
"(",
"'no secret key defined'",
")",
"if",
"expires",
":",
"self",
"[",
"'_expires'",
"]",
"=",
"_date_to_unix",
"(",
"expires",
")",
"result",
"=",
"[",
"]",
"mac",
"=",
"hmac",
"(",
"self",
".",
"secret_key",
",",
"None",
",",
"self",
".",
"hash_method",
")",
"for",
"key",
",",
"value",
"in",
"sorted",
"(",
"self",
".",
"items",
"(",
")",
")",
":",
"result",
".",
"append",
"(",
"(",
"'%s=%s'",
"%",
"(",
"url_quote_plus",
"(",
"key",
")",
",",
"self",
".",
"quote",
"(",
"value",
")",
".",
"decode",
"(",
"'ascii'",
")",
")",
")",
".",
"encode",
"(",
"'ascii'",
")",
")",
"mac",
".",
"update",
"(",
"b'|'",
"+",
"result",
"[",
"-",
"1",
"]",
")",
"return",
"b'?'",
".",
"join",
"(",
"[",
"base64",
".",
"b64encode",
"(",
"mac",
".",
"digest",
"(",
")",
")",
".",
"strip",
"(",
")",
",",
"b'&'",
".",
"join",
"(",
"result",
")",
"]",
")"
] |
Serialize the secure cookie into a string.
If expires is provided, the session will be automatically invalidated
after expiration when you unseralize it. This provides better
protection against session cookie theft.
:param expires: an optional expiration date for the cookie (a
:class:`datetime.datetime` object)
|
[
"Serialize",
"the",
"secure",
"cookie",
"into",
"a",
"string",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/contrib/securecookie.py#L203-L228
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/contrib/securecookie.py
|
SecureCookie.unserialize
|
def unserialize(cls, string, secret_key):
"""Load the secure cookie from a serialized string.
:param string: the cookie value to unserialize.
:param secret_key: the secret key used to serialize the cookie.
:return: a new :class:`SecureCookie`.
"""
if isinstance(string, text_type):
string = string.encode('utf-8', 'replace')
if isinstance(secret_key, text_type):
secret_key = secret_key.encode('utf-8', 'replace')
try:
base64_hash, data = string.split(b'?', 1)
except (ValueError, IndexError):
items = ()
else:
items = {}
mac = hmac(secret_key, None, cls.hash_method)
for item in data.split(b'&'):
mac.update(b'|' + item)
if not b'=' in item:
items = None
break
key, value = item.split(b'=', 1)
# try to make the key a string
key = url_unquote_plus(key.decode('ascii'))
try:
key = to_native(key)
except UnicodeError:
pass
items[key] = value
# no parsing error and the mac looks okay, we can now
# sercurely unpickle our cookie.
try:
client_hash = base64.b64decode(base64_hash)
except TypeError:
items = client_hash = None
if items is not None and safe_str_cmp(client_hash, mac.digest()):
try:
for key, value in iteritems(items):
items[key] = cls.unquote(value)
except UnquoteError:
items = ()
else:
if '_expires' in items:
if time() > items['_expires']:
items = ()
else:
del items['_expires']
else:
items = ()
return cls(items, secret_key, False)
|
python
|
def unserialize(cls, string, secret_key):
"""Load the secure cookie from a serialized string.
:param string: the cookie value to unserialize.
:param secret_key: the secret key used to serialize the cookie.
:return: a new :class:`SecureCookie`.
"""
if isinstance(string, text_type):
string = string.encode('utf-8', 'replace')
if isinstance(secret_key, text_type):
secret_key = secret_key.encode('utf-8', 'replace')
try:
base64_hash, data = string.split(b'?', 1)
except (ValueError, IndexError):
items = ()
else:
items = {}
mac = hmac(secret_key, None, cls.hash_method)
for item in data.split(b'&'):
mac.update(b'|' + item)
if not b'=' in item:
items = None
break
key, value = item.split(b'=', 1)
# try to make the key a string
key = url_unquote_plus(key.decode('ascii'))
try:
key = to_native(key)
except UnicodeError:
pass
items[key] = value
# no parsing error and the mac looks okay, we can now
# sercurely unpickle our cookie.
try:
client_hash = base64.b64decode(base64_hash)
except TypeError:
items = client_hash = None
if items is not None and safe_str_cmp(client_hash, mac.digest()):
try:
for key, value in iteritems(items):
items[key] = cls.unquote(value)
except UnquoteError:
items = ()
else:
if '_expires' in items:
if time() > items['_expires']:
items = ()
else:
del items['_expires']
else:
items = ()
return cls(items, secret_key, False)
|
[
"def",
"unserialize",
"(",
"cls",
",",
"string",
",",
"secret_key",
")",
":",
"if",
"isinstance",
"(",
"string",
",",
"text_type",
")",
":",
"string",
"=",
"string",
".",
"encode",
"(",
"'utf-8'",
",",
"'replace'",
")",
"if",
"isinstance",
"(",
"secret_key",
",",
"text_type",
")",
":",
"secret_key",
"=",
"secret_key",
".",
"encode",
"(",
"'utf-8'",
",",
"'replace'",
")",
"try",
":",
"base64_hash",
",",
"data",
"=",
"string",
".",
"split",
"(",
"b'?'",
",",
"1",
")",
"except",
"(",
"ValueError",
",",
"IndexError",
")",
":",
"items",
"=",
"(",
")",
"else",
":",
"items",
"=",
"{",
"}",
"mac",
"=",
"hmac",
"(",
"secret_key",
",",
"None",
",",
"cls",
".",
"hash_method",
")",
"for",
"item",
"in",
"data",
".",
"split",
"(",
"b'&'",
")",
":",
"mac",
".",
"update",
"(",
"b'|'",
"+",
"item",
")",
"if",
"not",
"b'='",
"in",
"item",
":",
"items",
"=",
"None",
"break",
"key",
",",
"value",
"=",
"item",
".",
"split",
"(",
"b'='",
",",
"1",
")",
"# try to make the key a string",
"key",
"=",
"url_unquote_plus",
"(",
"key",
".",
"decode",
"(",
"'ascii'",
")",
")",
"try",
":",
"key",
"=",
"to_native",
"(",
"key",
")",
"except",
"UnicodeError",
":",
"pass",
"items",
"[",
"key",
"]",
"=",
"value",
"# no parsing error and the mac looks okay, we can now",
"# sercurely unpickle our cookie.",
"try",
":",
"client_hash",
"=",
"base64",
".",
"b64decode",
"(",
"base64_hash",
")",
"except",
"TypeError",
":",
"items",
"=",
"client_hash",
"=",
"None",
"if",
"items",
"is",
"not",
"None",
"and",
"safe_str_cmp",
"(",
"client_hash",
",",
"mac",
".",
"digest",
"(",
")",
")",
":",
"try",
":",
"for",
"key",
",",
"value",
"in",
"iteritems",
"(",
"items",
")",
":",
"items",
"[",
"key",
"]",
"=",
"cls",
".",
"unquote",
"(",
"value",
")",
"except",
"UnquoteError",
":",
"items",
"=",
"(",
")",
"else",
":",
"if",
"'_expires'",
"in",
"items",
":",
"if",
"time",
"(",
")",
">",
"items",
"[",
"'_expires'",
"]",
":",
"items",
"=",
"(",
")",
"else",
":",
"del",
"items",
"[",
"'_expires'",
"]",
"else",
":",
"items",
"=",
"(",
")",
"return",
"cls",
"(",
"items",
",",
"secret_key",
",",
"False",
")"
] |
Load the secure cookie from a serialized string.
:param string: the cookie value to unserialize.
:param secret_key: the secret key used to serialize the cookie.
:return: a new :class:`SecureCookie`.
|
[
"Load",
"the",
"secure",
"cookie",
"from",
"a",
"serialized",
"string",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/contrib/securecookie.py#L231-L283
|
train
|
limodou/uliweb
|
uliweb/contrib/model_config/__init__.py
|
find_model
|
def find_model(sender, model_name):
"""
Register new model to ORM
"""
MC = get_mc()
model = MC.get((MC.c.model_name==model_name) & (MC.c.uuid!=''))
if model:
model_inst = model.get_instance()
orm.set_model(model_name, model_inst.table_name, appname=__name__, model_path='')
return orm.__models__.get(model_name)
|
python
|
def find_model(sender, model_name):
"""
Register new model to ORM
"""
MC = get_mc()
model = MC.get((MC.c.model_name==model_name) & (MC.c.uuid!=''))
if model:
model_inst = model.get_instance()
orm.set_model(model_name, model_inst.table_name, appname=__name__, model_path='')
return orm.__models__.get(model_name)
|
[
"def",
"find_model",
"(",
"sender",
",",
"model_name",
")",
":",
"MC",
"=",
"get_mc",
"(",
")",
"model",
"=",
"MC",
".",
"get",
"(",
"(",
"MC",
".",
"c",
".",
"model_name",
"==",
"model_name",
")",
"&",
"(",
"MC",
".",
"c",
".",
"uuid",
"!=",
"''",
")",
")",
"if",
"model",
":",
"model_inst",
"=",
"model",
".",
"get_instance",
"(",
")",
"orm",
".",
"set_model",
"(",
"model_name",
",",
"model_inst",
".",
"table_name",
",",
"appname",
"=",
"__name__",
",",
"model_path",
"=",
"''",
")",
"return",
"orm",
".",
"__models__",
".",
"get",
"(",
"model_name",
")"
] |
Register new model to ORM
|
[
"Register",
"new",
"model",
"to",
"ORM"
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/contrib/model_config/__init__.py#L20-L29
|
train
|
limodou/uliweb
|
uliweb/contrib/model_config/__init__.py
|
get_model_fields
|
def get_model_fields(model, add_reserver_flag=True):
"""
Creating fields suit for model_config , id will be skipped.
"""
import uliweb.orm as orm
fields = []
m = {'type':'type_name', 'hint':'hint',
'default':'default', 'required':'required'}
m1 = {'index':'index', 'unique':'unique'}
for name, prop in model.properties.items():
if name == 'id':
continue
d = {}
for k, v in m.items():
d[k] = getattr(prop, v)
for k, v in m1.items():
d[k] = bool(prop.kwargs.get(v))
d['name'] = prop.fieldname or name
d['verbose_name'] = unicode(prop.verbose_name)
d['nullable'] = bool(prop.kwargs.get('nullable', orm.__nullable__))
if d['type'] in ('VARCHAR', 'CHAR', 'BINARY', 'VARBINARY'):
d['max_length'] = prop.max_length
if d['type'] in ('Reference', 'OneToOne', 'ManyToMany'):
d['reference_class'] = prop.reference_class
#collection_name will be _collection_name, it the original value
d['collection_name'] = prop._collection_name
d['server_default'] = prop.kwargs.get('server_default')
d['_reserved'] = True
fields.append(d)
return fields
|
python
|
def get_model_fields(model, add_reserver_flag=True):
"""
Creating fields suit for model_config , id will be skipped.
"""
import uliweb.orm as orm
fields = []
m = {'type':'type_name', 'hint':'hint',
'default':'default', 'required':'required'}
m1 = {'index':'index', 'unique':'unique'}
for name, prop in model.properties.items():
if name == 'id':
continue
d = {}
for k, v in m.items():
d[k] = getattr(prop, v)
for k, v in m1.items():
d[k] = bool(prop.kwargs.get(v))
d['name'] = prop.fieldname or name
d['verbose_name'] = unicode(prop.verbose_name)
d['nullable'] = bool(prop.kwargs.get('nullable', orm.__nullable__))
if d['type'] in ('VARCHAR', 'CHAR', 'BINARY', 'VARBINARY'):
d['max_length'] = prop.max_length
if d['type'] in ('Reference', 'OneToOne', 'ManyToMany'):
d['reference_class'] = prop.reference_class
#collection_name will be _collection_name, it the original value
d['collection_name'] = prop._collection_name
d['server_default'] = prop.kwargs.get('server_default')
d['_reserved'] = True
fields.append(d)
return fields
|
[
"def",
"get_model_fields",
"(",
"model",
",",
"add_reserver_flag",
"=",
"True",
")",
":",
"import",
"uliweb",
".",
"orm",
"as",
"orm",
"fields",
"=",
"[",
"]",
"m",
"=",
"{",
"'type'",
":",
"'type_name'",
",",
"'hint'",
":",
"'hint'",
",",
"'default'",
":",
"'default'",
",",
"'required'",
":",
"'required'",
"}",
"m1",
"=",
"{",
"'index'",
":",
"'index'",
",",
"'unique'",
":",
"'unique'",
"}",
"for",
"name",
",",
"prop",
"in",
"model",
".",
"properties",
".",
"items",
"(",
")",
":",
"if",
"name",
"==",
"'id'",
":",
"continue",
"d",
"=",
"{",
"}",
"for",
"k",
",",
"v",
"in",
"m",
".",
"items",
"(",
")",
":",
"d",
"[",
"k",
"]",
"=",
"getattr",
"(",
"prop",
",",
"v",
")",
"for",
"k",
",",
"v",
"in",
"m1",
".",
"items",
"(",
")",
":",
"d",
"[",
"k",
"]",
"=",
"bool",
"(",
"prop",
".",
"kwargs",
".",
"get",
"(",
"v",
")",
")",
"d",
"[",
"'name'",
"]",
"=",
"prop",
".",
"fieldname",
"or",
"name",
"d",
"[",
"'verbose_name'",
"]",
"=",
"unicode",
"(",
"prop",
".",
"verbose_name",
")",
"d",
"[",
"'nullable'",
"]",
"=",
"bool",
"(",
"prop",
".",
"kwargs",
".",
"get",
"(",
"'nullable'",
",",
"orm",
".",
"__nullable__",
")",
")",
"if",
"d",
"[",
"'type'",
"]",
"in",
"(",
"'VARCHAR'",
",",
"'CHAR'",
",",
"'BINARY'",
",",
"'VARBINARY'",
")",
":",
"d",
"[",
"'max_length'",
"]",
"=",
"prop",
".",
"max_length",
"if",
"d",
"[",
"'type'",
"]",
"in",
"(",
"'Reference'",
",",
"'OneToOne'",
",",
"'ManyToMany'",
")",
":",
"d",
"[",
"'reference_class'",
"]",
"=",
"prop",
".",
"reference_class",
"#collection_name will be _collection_name, it the original value",
"d",
"[",
"'collection_name'",
"]",
"=",
"prop",
".",
"_collection_name",
"d",
"[",
"'server_default'",
"]",
"=",
"prop",
".",
"kwargs",
".",
"get",
"(",
"'server_default'",
")",
"d",
"[",
"'_reserved'",
"]",
"=",
"True",
"fields",
".",
"append",
"(",
"d",
")",
"return",
"fields"
] |
Creating fields suit for model_config , id will be skipped.
|
[
"Creating",
"fields",
"suit",
"for",
"model_config",
"id",
"will",
"be",
"skipped",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/contrib/model_config/__init__.py#L69-L100
|
train
|
limodou/uliweb
|
uliweb/contrib/model_config/__init__.py
|
get_model_indexes
|
def get_model_indexes(model, add_reserver_flag=True):
"""
Creating indexes suit for model_config.
"""
import uliweb.orm as orm
from sqlalchemy.engine.reflection import Inspector
indexes = []
engine = model.get_engine().engine
insp = Inspector.from_engine(engine)
for index in insp.get_indexes(model.tablename):
d = {}
d['name'] = index['name']
d['unique'] = index['unique']
d['fields'] = index['column_names']
if add_reserver_flag:
d['_reserved'] = True
indexes.append(d)
return indexes
|
python
|
def get_model_indexes(model, add_reserver_flag=True):
"""
Creating indexes suit for model_config.
"""
import uliweb.orm as orm
from sqlalchemy.engine.reflection import Inspector
indexes = []
engine = model.get_engine().engine
insp = Inspector.from_engine(engine)
for index in insp.get_indexes(model.tablename):
d = {}
d['name'] = index['name']
d['unique'] = index['unique']
d['fields'] = index['column_names']
if add_reserver_flag:
d['_reserved'] = True
indexes.append(d)
return indexes
|
[
"def",
"get_model_indexes",
"(",
"model",
",",
"add_reserver_flag",
"=",
"True",
")",
":",
"import",
"uliweb",
".",
"orm",
"as",
"orm",
"from",
"sqlalchemy",
".",
"engine",
".",
"reflection",
"import",
"Inspector",
"indexes",
"=",
"[",
"]",
"engine",
"=",
"model",
".",
"get_engine",
"(",
")",
".",
"engine",
"insp",
"=",
"Inspector",
".",
"from_engine",
"(",
"engine",
")",
"for",
"index",
"in",
"insp",
".",
"get_indexes",
"(",
"model",
".",
"tablename",
")",
":",
"d",
"=",
"{",
"}",
"d",
"[",
"'name'",
"]",
"=",
"index",
"[",
"'name'",
"]",
"d",
"[",
"'unique'",
"]",
"=",
"index",
"[",
"'unique'",
"]",
"d",
"[",
"'fields'",
"]",
"=",
"index",
"[",
"'column_names'",
"]",
"if",
"add_reserver_flag",
":",
"d",
"[",
"'_reserved'",
"]",
"=",
"True",
"indexes",
".",
"append",
"(",
"d",
")",
"return",
"indexes"
] |
Creating indexes suit for model_config.
|
[
"Creating",
"indexes",
"suit",
"for",
"model_config",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/contrib/model_config/__init__.py#L102-L121
|
train
|
limodou/uliweb
|
uliweb/utils/timeit.py
|
timeit
|
def timeit(output):
"""
If output is string, then print the string and also time used
"""
b = time.time()
yield
print output, 'time used: %.3fs' % (time.time()-b)
|
python
|
def timeit(output):
"""
If output is string, then print the string and also time used
"""
b = time.time()
yield
print output, 'time used: %.3fs' % (time.time()-b)
|
[
"def",
"timeit",
"(",
"output",
")",
":",
"b",
"=",
"time",
".",
"time",
"(",
")",
"yield",
"print",
"output",
",",
"'time used: %.3fs'",
"%",
"(",
"time",
".",
"time",
"(",
")",
"-",
"b",
")"
] |
If output is string, then print the string and also time used
|
[
"If",
"output",
"is",
"string",
"then",
"print",
"the",
"string",
"and",
"also",
"time",
"used"
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/utils/timeit.py#L5-L11
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/wsgi.py
|
host_is_trusted
|
def host_is_trusted(hostname, trusted_list):
"""Checks if a host is trusted against a list. This also takes care
of port normalization.
.. versionadded:: 0.9
:param hostname: the hostname to check
:param trusted_list: a list of hostnames to check against. If a
hostname starts with a dot it will match against
all subdomains as well.
"""
if not hostname:
return False
if isinstance(trusted_list, string_types):
trusted_list = [trusted_list]
def _normalize(hostname):
if ':' in hostname:
hostname = hostname.rsplit(':', 1)[0]
return _encode_idna(hostname)
hostname = _normalize(hostname)
for ref in trusted_list:
if ref.startswith('.'):
ref = ref[1:]
suffix_match = True
else:
suffix_match = False
ref = _normalize(ref)
if ref == hostname:
return True
if suffix_match and hostname.endswith('.' + ref):
return True
return False
|
python
|
def host_is_trusted(hostname, trusted_list):
"""Checks if a host is trusted against a list. This also takes care
of port normalization.
.. versionadded:: 0.9
:param hostname: the hostname to check
:param trusted_list: a list of hostnames to check against. If a
hostname starts with a dot it will match against
all subdomains as well.
"""
if not hostname:
return False
if isinstance(trusted_list, string_types):
trusted_list = [trusted_list]
def _normalize(hostname):
if ':' in hostname:
hostname = hostname.rsplit(':', 1)[0]
return _encode_idna(hostname)
hostname = _normalize(hostname)
for ref in trusted_list:
if ref.startswith('.'):
ref = ref[1:]
suffix_match = True
else:
suffix_match = False
ref = _normalize(ref)
if ref == hostname:
return True
if suffix_match and hostname.endswith('.' + ref):
return True
return False
|
[
"def",
"host_is_trusted",
"(",
"hostname",
",",
"trusted_list",
")",
":",
"if",
"not",
"hostname",
":",
"return",
"False",
"if",
"isinstance",
"(",
"trusted_list",
",",
"string_types",
")",
":",
"trusted_list",
"=",
"[",
"trusted_list",
"]",
"def",
"_normalize",
"(",
"hostname",
")",
":",
"if",
"':'",
"in",
"hostname",
":",
"hostname",
"=",
"hostname",
".",
"rsplit",
"(",
"':'",
",",
"1",
")",
"[",
"0",
"]",
"return",
"_encode_idna",
"(",
"hostname",
")",
"hostname",
"=",
"_normalize",
"(",
"hostname",
")",
"for",
"ref",
"in",
"trusted_list",
":",
"if",
"ref",
".",
"startswith",
"(",
"'.'",
")",
":",
"ref",
"=",
"ref",
"[",
"1",
":",
"]",
"suffix_match",
"=",
"True",
"else",
":",
"suffix_match",
"=",
"False",
"ref",
"=",
"_normalize",
"(",
"ref",
")",
"if",
"ref",
"==",
"hostname",
":",
"return",
"True",
"if",
"suffix_match",
"and",
"hostname",
".",
"endswith",
"(",
"'.'",
"+",
"ref",
")",
":",
"return",
"True",
"return",
"False"
] |
Checks if a host is trusted against a list. This also takes care
of port normalization.
.. versionadded:: 0.9
:param hostname: the hostname to check
:param trusted_list: a list of hostnames to check against. If a
hostname starts with a dot it will match against
all subdomains as well.
|
[
"Checks",
"if",
"a",
"host",
"is",
"trusted",
"against",
"a",
"list",
".",
"This",
"also",
"takes",
"care",
"of",
"port",
"normalization",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/wsgi.py#L85-L119
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/wsgi.py
|
get_content_length
|
def get_content_length(environ):
"""Returns the content length from the WSGI environment as
integer. If it's not available `None` is returned.
.. versionadded:: 0.9
:param environ: the WSGI environ to fetch the content length from.
"""
content_length = environ.get('CONTENT_LENGTH')
if content_length is not None:
try:
return max(0, int(content_length))
except (ValueError, TypeError):
pass
|
python
|
def get_content_length(environ):
"""Returns the content length from the WSGI environment as
integer. If it's not available `None` is returned.
.. versionadded:: 0.9
:param environ: the WSGI environ to fetch the content length from.
"""
content_length = environ.get('CONTENT_LENGTH')
if content_length is not None:
try:
return max(0, int(content_length))
except (ValueError, TypeError):
pass
|
[
"def",
"get_content_length",
"(",
"environ",
")",
":",
"content_length",
"=",
"environ",
".",
"get",
"(",
"'CONTENT_LENGTH'",
")",
"if",
"content_length",
"is",
"not",
"None",
":",
"try",
":",
"return",
"max",
"(",
"0",
",",
"int",
"(",
"content_length",
")",
")",
"except",
"(",
"ValueError",
",",
"TypeError",
")",
":",
"pass"
] |
Returns the content length from the WSGI environment as
integer. If it's not available `None` is returned.
.. versionadded:: 0.9
:param environ: the WSGI environ to fetch the content length from.
|
[
"Returns",
"the",
"content",
"length",
"from",
"the",
"WSGI",
"environment",
"as",
"integer",
".",
"If",
"it",
"s",
"not",
"available",
"None",
"is",
"returned",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/wsgi.py#L148-L161
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/wsgi.py
|
get_input_stream
|
def get_input_stream(environ, safe_fallback=True):
"""Returns the input stream from the WSGI environment and wraps it
in the most sensible way possible. The stream returned is not the
raw WSGI stream in most cases but one that is safe to read from
without taking into account the content length.
.. versionadded:: 0.9
:param environ: the WSGI environ to fetch the stream from.
:param safe: indicates weather the function should use an empty
stream as safe fallback or just return the original
WSGI input stream if it can't wrap it safely. The
default is to return an empty string in those cases.
"""
stream = environ['wsgi.input']
content_length = get_content_length(environ)
# A wsgi extension that tells us if the input is terminated. In
# that case we return the stream unchanged as we know we can savely
# read it until the end.
if environ.get('wsgi.input_terminated'):
return stream
# If we don't have a content length we fall back to an empty stream
# in case of a safe fallback, otherwise we return the stream unchanged.
# The non-safe fallback is not recommended but might be useful in
# some situations.
if content_length is None:
return safe_fallback and _empty_stream or stream
# Otherwise limit the stream to the content length
return LimitedStream(stream, content_length)
|
python
|
def get_input_stream(environ, safe_fallback=True):
"""Returns the input stream from the WSGI environment and wraps it
in the most sensible way possible. The stream returned is not the
raw WSGI stream in most cases but one that is safe to read from
without taking into account the content length.
.. versionadded:: 0.9
:param environ: the WSGI environ to fetch the stream from.
:param safe: indicates weather the function should use an empty
stream as safe fallback or just return the original
WSGI input stream if it can't wrap it safely. The
default is to return an empty string in those cases.
"""
stream = environ['wsgi.input']
content_length = get_content_length(environ)
# A wsgi extension that tells us if the input is terminated. In
# that case we return the stream unchanged as we know we can savely
# read it until the end.
if environ.get('wsgi.input_terminated'):
return stream
# If we don't have a content length we fall back to an empty stream
# in case of a safe fallback, otherwise we return the stream unchanged.
# The non-safe fallback is not recommended but might be useful in
# some situations.
if content_length is None:
return safe_fallback and _empty_stream or stream
# Otherwise limit the stream to the content length
return LimitedStream(stream, content_length)
|
[
"def",
"get_input_stream",
"(",
"environ",
",",
"safe_fallback",
"=",
"True",
")",
":",
"stream",
"=",
"environ",
"[",
"'wsgi.input'",
"]",
"content_length",
"=",
"get_content_length",
"(",
"environ",
")",
"# A wsgi extension that tells us if the input is terminated. In",
"# that case we return the stream unchanged as we know we can savely",
"# read it until the end.",
"if",
"environ",
".",
"get",
"(",
"'wsgi.input_terminated'",
")",
":",
"return",
"stream",
"# If we don't have a content length we fall back to an empty stream",
"# in case of a safe fallback, otherwise we return the stream unchanged.",
"# The non-safe fallback is not recommended but might be useful in",
"# some situations.",
"if",
"content_length",
"is",
"None",
":",
"return",
"safe_fallback",
"and",
"_empty_stream",
"or",
"stream",
"# Otherwise limit the stream to the content length",
"return",
"LimitedStream",
"(",
"stream",
",",
"content_length",
")"
] |
Returns the input stream from the WSGI environment and wraps it
in the most sensible way possible. The stream returned is not the
raw WSGI stream in most cases but one that is safe to read from
without taking into account the content length.
.. versionadded:: 0.9
:param environ: the WSGI environ to fetch the stream from.
:param safe: indicates weather the function should use an empty
stream as safe fallback or just return the original
WSGI input stream if it can't wrap it safely. The
default is to return an empty string in those cases.
|
[
"Returns",
"the",
"input",
"stream",
"from",
"the",
"WSGI",
"environment",
"and",
"wraps",
"it",
"in",
"the",
"most",
"sensible",
"way",
"possible",
".",
"The",
"stream",
"returned",
"is",
"not",
"the",
"raw",
"WSGI",
"stream",
"in",
"most",
"cases",
"but",
"one",
"that",
"is",
"safe",
"to",
"read",
"from",
"without",
"taking",
"into",
"account",
"the",
"content",
"length",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/wsgi.py#L164-L195
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/wsgi.py
|
get_path_info
|
def get_path_info(environ, charset='utf-8', errors='replace'):
"""Returns the `PATH_INFO` from the WSGI environment and properly
decodes it. This also takes care about the WSGI decoding dance
on Python 3 environments. if the `charset` is set to `None` a
bytestring is returned.
.. versionadded:: 0.9
:param environ: the WSGI environment object to get the path from.
:param charset: the charset for the path info, or `None` if no
decoding should be performed.
:param errors: the decoding error handling.
"""
path = wsgi_get_bytes(environ.get('PATH_INFO', ''))
return to_unicode(path, charset, errors, allow_none_charset=True)
|
python
|
def get_path_info(environ, charset='utf-8', errors='replace'):
"""Returns the `PATH_INFO` from the WSGI environment and properly
decodes it. This also takes care about the WSGI decoding dance
on Python 3 environments. if the `charset` is set to `None` a
bytestring is returned.
.. versionadded:: 0.9
:param environ: the WSGI environment object to get the path from.
:param charset: the charset for the path info, or `None` if no
decoding should be performed.
:param errors: the decoding error handling.
"""
path = wsgi_get_bytes(environ.get('PATH_INFO', ''))
return to_unicode(path, charset, errors, allow_none_charset=True)
|
[
"def",
"get_path_info",
"(",
"environ",
",",
"charset",
"=",
"'utf-8'",
",",
"errors",
"=",
"'replace'",
")",
":",
"path",
"=",
"wsgi_get_bytes",
"(",
"environ",
".",
"get",
"(",
"'PATH_INFO'",
",",
"''",
")",
")",
"return",
"to_unicode",
"(",
"path",
",",
"charset",
",",
"errors",
",",
"allow_none_charset",
"=",
"True",
")"
] |
Returns the `PATH_INFO` from the WSGI environment and properly
decodes it. This also takes care about the WSGI decoding dance
on Python 3 environments. if the `charset` is set to `None` a
bytestring is returned.
.. versionadded:: 0.9
:param environ: the WSGI environment object to get the path from.
:param charset: the charset for the path info, or `None` if no
decoding should be performed.
:param errors: the decoding error handling.
|
[
"Returns",
"the",
"PATH_INFO",
"from",
"the",
"WSGI",
"environment",
"and",
"properly",
"decodes",
"it",
".",
"This",
"also",
"takes",
"care",
"about",
"the",
"WSGI",
"decoding",
"dance",
"on",
"Python",
"3",
"environments",
".",
"if",
"the",
"charset",
"is",
"set",
"to",
"None",
"a",
"bytestring",
"is",
"returned",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/wsgi.py#L215-L229
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/wsgi.py
|
pop_path_info
|
def pop_path_info(environ, charset='utf-8', errors='replace'):
"""Removes and returns the next segment of `PATH_INFO`, pushing it onto
`SCRIPT_NAME`. Returns `None` if there is nothing left on `PATH_INFO`.
If the `charset` is set to `None` a bytestring is returned.
If there are empty segments (``'/foo//bar``) these are ignored but
properly pushed to the `SCRIPT_NAME`:
>>> env = {'SCRIPT_NAME': '/foo', 'PATH_INFO': '/a/b'}
>>> pop_path_info(env)
'a'
>>> env['SCRIPT_NAME']
'/foo/a'
>>> pop_path_info(env)
'b'
>>> env['SCRIPT_NAME']
'/foo/a/b'
.. versionadded:: 0.5
.. versionchanged:: 0.9
The path is now decoded and a charset and encoding
parameter can be provided.
:param environ: the WSGI environment that is modified.
"""
path = environ.get('PATH_INFO')
if not path:
return None
script_name = environ.get('SCRIPT_NAME', '')
# shift multiple leading slashes over
old_path = path
path = path.lstrip('/')
if path != old_path:
script_name += '/' * (len(old_path) - len(path))
if '/' not in path:
environ['PATH_INFO'] = ''
environ['SCRIPT_NAME'] = script_name + path
rv = wsgi_get_bytes(path)
else:
segment, path = path.split('/', 1)
environ['PATH_INFO'] = '/' + path
environ['SCRIPT_NAME'] = script_name + segment
rv = wsgi_get_bytes(segment)
return to_unicode(rv, charset, errors, allow_none_charset=True)
|
python
|
def pop_path_info(environ, charset='utf-8', errors='replace'):
"""Removes and returns the next segment of `PATH_INFO`, pushing it onto
`SCRIPT_NAME`. Returns `None` if there is nothing left on `PATH_INFO`.
If the `charset` is set to `None` a bytestring is returned.
If there are empty segments (``'/foo//bar``) these are ignored but
properly pushed to the `SCRIPT_NAME`:
>>> env = {'SCRIPT_NAME': '/foo', 'PATH_INFO': '/a/b'}
>>> pop_path_info(env)
'a'
>>> env['SCRIPT_NAME']
'/foo/a'
>>> pop_path_info(env)
'b'
>>> env['SCRIPT_NAME']
'/foo/a/b'
.. versionadded:: 0.5
.. versionchanged:: 0.9
The path is now decoded and a charset and encoding
parameter can be provided.
:param environ: the WSGI environment that is modified.
"""
path = environ.get('PATH_INFO')
if not path:
return None
script_name = environ.get('SCRIPT_NAME', '')
# shift multiple leading slashes over
old_path = path
path = path.lstrip('/')
if path != old_path:
script_name += '/' * (len(old_path) - len(path))
if '/' not in path:
environ['PATH_INFO'] = ''
environ['SCRIPT_NAME'] = script_name + path
rv = wsgi_get_bytes(path)
else:
segment, path = path.split('/', 1)
environ['PATH_INFO'] = '/' + path
environ['SCRIPT_NAME'] = script_name + segment
rv = wsgi_get_bytes(segment)
return to_unicode(rv, charset, errors, allow_none_charset=True)
|
[
"def",
"pop_path_info",
"(",
"environ",
",",
"charset",
"=",
"'utf-8'",
",",
"errors",
"=",
"'replace'",
")",
":",
"path",
"=",
"environ",
".",
"get",
"(",
"'PATH_INFO'",
")",
"if",
"not",
"path",
":",
"return",
"None",
"script_name",
"=",
"environ",
".",
"get",
"(",
"'SCRIPT_NAME'",
",",
"''",
")",
"# shift multiple leading slashes over",
"old_path",
"=",
"path",
"path",
"=",
"path",
".",
"lstrip",
"(",
"'/'",
")",
"if",
"path",
"!=",
"old_path",
":",
"script_name",
"+=",
"'/'",
"*",
"(",
"len",
"(",
"old_path",
")",
"-",
"len",
"(",
"path",
")",
")",
"if",
"'/'",
"not",
"in",
"path",
":",
"environ",
"[",
"'PATH_INFO'",
"]",
"=",
"''",
"environ",
"[",
"'SCRIPT_NAME'",
"]",
"=",
"script_name",
"+",
"path",
"rv",
"=",
"wsgi_get_bytes",
"(",
"path",
")",
"else",
":",
"segment",
",",
"path",
"=",
"path",
".",
"split",
"(",
"'/'",
",",
"1",
")",
"environ",
"[",
"'PATH_INFO'",
"]",
"=",
"'/'",
"+",
"path",
"environ",
"[",
"'SCRIPT_NAME'",
"]",
"=",
"script_name",
"+",
"segment",
"rv",
"=",
"wsgi_get_bytes",
"(",
"segment",
")",
"return",
"to_unicode",
"(",
"rv",
",",
"charset",
",",
"errors",
",",
"allow_none_charset",
"=",
"True",
")"
] |
Removes and returns the next segment of `PATH_INFO`, pushing it onto
`SCRIPT_NAME`. Returns `None` if there is nothing left on `PATH_INFO`.
If the `charset` is set to `None` a bytestring is returned.
If there are empty segments (``'/foo//bar``) these are ignored but
properly pushed to the `SCRIPT_NAME`:
>>> env = {'SCRIPT_NAME': '/foo', 'PATH_INFO': '/a/b'}
>>> pop_path_info(env)
'a'
>>> env['SCRIPT_NAME']
'/foo/a'
>>> pop_path_info(env)
'b'
>>> env['SCRIPT_NAME']
'/foo/a/b'
.. versionadded:: 0.5
.. versionchanged:: 0.9
The path is now decoded and a charset and encoding
parameter can be provided.
:param environ: the WSGI environment that is modified.
|
[
"Removes",
"and",
"returns",
"the",
"next",
"segment",
"of",
"PATH_INFO",
"pushing",
"it",
"onto",
"SCRIPT_NAME",
".",
"Returns",
"None",
"if",
"there",
"is",
"nothing",
"left",
"on",
"PATH_INFO",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/wsgi.py#L249-L298
|
train
|
limodou/uliweb
|
uliweb/lib/werkzeug/wsgi.py
|
_make_chunk_iter
|
def _make_chunk_iter(stream, limit, buffer_size):
"""Helper for the line and chunk iter functions."""
if isinstance(stream, (bytes, bytearray, text_type)):
raise TypeError('Passed a string or byte object instead of '
'true iterator or stream.')
if not hasattr(stream, 'read'):
for item in stream:
if item:
yield item
return
if not isinstance(stream, LimitedStream) and limit is not None:
stream = LimitedStream(stream, limit)
_read = stream.read
while 1:
item = _read(buffer_size)
if not item:
break
yield item
|
python
|
def _make_chunk_iter(stream, limit, buffer_size):
"""Helper for the line and chunk iter functions."""
if isinstance(stream, (bytes, bytearray, text_type)):
raise TypeError('Passed a string or byte object instead of '
'true iterator or stream.')
if not hasattr(stream, 'read'):
for item in stream:
if item:
yield item
return
if not isinstance(stream, LimitedStream) and limit is not None:
stream = LimitedStream(stream, limit)
_read = stream.read
while 1:
item = _read(buffer_size)
if not item:
break
yield item
|
[
"def",
"_make_chunk_iter",
"(",
"stream",
",",
"limit",
",",
"buffer_size",
")",
":",
"if",
"isinstance",
"(",
"stream",
",",
"(",
"bytes",
",",
"bytearray",
",",
"text_type",
")",
")",
":",
"raise",
"TypeError",
"(",
"'Passed a string or byte object instead of '",
"'true iterator or stream.'",
")",
"if",
"not",
"hasattr",
"(",
"stream",
",",
"'read'",
")",
":",
"for",
"item",
"in",
"stream",
":",
"if",
"item",
":",
"yield",
"item",
"return",
"if",
"not",
"isinstance",
"(",
"stream",
",",
"LimitedStream",
")",
"and",
"limit",
"is",
"not",
"None",
":",
"stream",
"=",
"LimitedStream",
"(",
"stream",
",",
"limit",
")",
"_read",
"=",
"stream",
".",
"read",
"while",
"1",
":",
"item",
"=",
"_read",
"(",
"buffer_size",
")",
"if",
"not",
"item",
":",
"break",
"yield",
"item"
] |
Helper for the line and chunk iter functions.
|
[
"Helper",
"for",
"the",
"line",
"and",
"chunk",
"iter",
"functions",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/lib/werkzeug/wsgi.py#L745-L762
|
train
|
limodou/uliweb
|
uliweb/contrib/soap/__init__.py
|
soap
|
def soap(func=None, name=None, returns=None, args=None, doc=None, target='SOAP'):
"""
soap supports multiple SOAP function collections, it'll save functions to
target dict, and you can give other target, but it should be keep up with
SoapView.target definition.
"""
global __soap_functions__
returns = _fix_soap_kwargs(returns)
args = _fix_soap_kwargs(args)
if isinstance(func, str) and not name:
return partial(soap, name=func, returns=returns, args=args, doc=doc, target=target)
if not func:
return partial(soap, name=name, returns=returns, args=args, doc=doc, target=target)
target_functions = __soap_functions__.setdefault(target, {})
if inspect.isfunction(func):
f_name = func.__name__
if name:
f_name = name
target_functions[f_name] = endpoint = ('.'.join([func.__module__, func.__name__]), returns, args, doc)
func.soap_endpoint = (f_name, endpoint)
elif inspect.isclass(func):
if not name:
name = func.__name__
for _name in dir(func):
f = getattr(func, _name)
if (inspect.ismethod(f) or inspect.isfunction(f)) and not _name.startswith('_'):
f_name = name + '.' + f.__name__
endpoint = ('.'.join([func.__module__, func.__name__, _name]), returns, args, doc)
if hasattr(f, 'soap_endpoint'):
#the method has already been decorate by soap
_n, _e = f.soap_endpoint
target_functions[name + '.' + _n] = endpoint
del target_functions[_n]
else:
target_functions[f_name] = endpoint
else:
raise Exception("Can't support this type [%r]" % func)
return func
|
python
|
def soap(func=None, name=None, returns=None, args=None, doc=None, target='SOAP'):
"""
soap supports multiple SOAP function collections, it'll save functions to
target dict, and you can give other target, but it should be keep up with
SoapView.target definition.
"""
global __soap_functions__
returns = _fix_soap_kwargs(returns)
args = _fix_soap_kwargs(args)
if isinstance(func, str) and not name:
return partial(soap, name=func, returns=returns, args=args, doc=doc, target=target)
if not func:
return partial(soap, name=name, returns=returns, args=args, doc=doc, target=target)
target_functions = __soap_functions__.setdefault(target, {})
if inspect.isfunction(func):
f_name = func.__name__
if name:
f_name = name
target_functions[f_name] = endpoint = ('.'.join([func.__module__, func.__name__]), returns, args, doc)
func.soap_endpoint = (f_name, endpoint)
elif inspect.isclass(func):
if not name:
name = func.__name__
for _name in dir(func):
f = getattr(func, _name)
if (inspect.ismethod(f) or inspect.isfunction(f)) and not _name.startswith('_'):
f_name = name + '.' + f.__name__
endpoint = ('.'.join([func.__module__, func.__name__, _name]), returns, args, doc)
if hasattr(f, 'soap_endpoint'):
#the method has already been decorate by soap
_n, _e = f.soap_endpoint
target_functions[name + '.' + _n] = endpoint
del target_functions[_n]
else:
target_functions[f_name] = endpoint
else:
raise Exception("Can't support this type [%r]" % func)
return func
|
[
"def",
"soap",
"(",
"func",
"=",
"None",
",",
"name",
"=",
"None",
",",
"returns",
"=",
"None",
",",
"args",
"=",
"None",
",",
"doc",
"=",
"None",
",",
"target",
"=",
"'SOAP'",
")",
":",
"global",
"__soap_functions__",
"returns",
"=",
"_fix_soap_kwargs",
"(",
"returns",
")",
"args",
"=",
"_fix_soap_kwargs",
"(",
"args",
")",
"if",
"isinstance",
"(",
"func",
",",
"str",
")",
"and",
"not",
"name",
":",
"return",
"partial",
"(",
"soap",
",",
"name",
"=",
"func",
",",
"returns",
"=",
"returns",
",",
"args",
"=",
"args",
",",
"doc",
"=",
"doc",
",",
"target",
"=",
"target",
")",
"if",
"not",
"func",
":",
"return",
"partial",
"(",
"soap",
",",
"name",
"=",
"name",
",",
"returns",
"=",
"returns",
",",
"args",
"=",
"args",
",",
"doc",
"=",
"doc",
",",
"target",
"=",
"target",
")",
"target_functions",
"=",
"__soap_functions__",
".",
"setdefault",
"(",
"target",
",",
"{",
"}",
")",
"if",
"inspect",
".",
"isfunction",
"(",
"func",
")",
":",
"f_name",
"=",
"func",
".",
"__name__",
"if",
"name",
":",
"f_name",
"=",
"name",
"target_functions",
"[",
"f_name",
"]",
"=",
"endpoint",
"=",
"(",
"'.'",
".",
"join",
"(",
"[",
"func",
".",
"__module__",
",",
"func",
".",
"__name__",
"]",
")",
",",
"returns",
",",
"args",
",",
"doc",
")",
"func",
".",
"soap_endpoint",
"=",
"(",
"f_name",
",",
"endpoint",
")",
"elif",
"inspect",
".",
"isclass",
"(",
"func",
")",
":",
"if",
"not",
"name",
":",
"name",
"=",
"func",
".",
"__name__",
"for",
"_name",
"in",
"dir",
"(",
"func",
")",
":",
"f",
"=",
"getattr",
"(",
"func",
",",
"_name",
")",
"if",
"(",
"inspect",
".",
"ismethod",
"(",
"f",
")",
"or",
"inspect",
".",
"isfunction",
"(",
"f",
")",
")",
"and",
"not",
"_name",
".",
"startswith",
"(",
"'_'",
")",
":",
"f_name",
"=",
"name",
"+",
"'.'",
"+",
"f",
".",
"__name__",
"endpoint",
"=",
"(",
"'.'",
".",
"join",
"(",
"[",
"func",
".",
"__module__",
",",
"func",
".",
"__name__",
",",
"_name",
"]",
")",
",",
"returns",
",",
"args",
",",
"doc",
")",
"if",
"hasattr",
"(",
"f",
",",
"'soap_endpoint'",
")",
":",
"#the method has already been decorate by soap ",
"_n",
",",
"_e",
"=",
"f",
".",
"soap_endpoint",
"target_functions",
"[",
"name",
"+",
"'.'",
"+",
"_n",
"]",
"=",
"endpoint",
"del",
"target_functions",
"[",
"_n",
"]",
"else",
":",
"target_functions",
"[",
"f_name",
"]",
"=",
"endpoint",
"else",
":",
"raise",
"Exception",
"(",
"\"Can't support this type [%r]\"",
"%",
"func",
")",
"return",
"func"
] |
soap supports multiple SOAP function collections, it'll save functions to
target dict, and you can give other target, but it should be keep up with
SoapView.target definition.
|
[
"soap",
"supports",
"multiple",
"SOAP",
"function",
"collections",
"it",
"ll",
"save",
"functions",
"to",
"target",
"dict",
"and",
"you",
"can",
"give",
"other",
"target",
"but",
"it",
"should",
"be",
"keep",
"up",
"with",
"SoapView",
".",
"target",
"definition",
"."
] |
34472f25e4bc0b954a35346672f94e84ef18b076
|
https://github.com/limodou/uliweb/blob/34472f25e4bc0b954a35346672f94e84ef18b076/uliweb/contrib/soap/__init__.py#L27-L68
|
train
|
adamhajari/spyre
|
spyre/server.py
|
App.getJsonData
|
def getJsonData(self, params):
"""turns the DataFrame returned by getData into a dictionary
arguments:
the params passed used for table or d3 outputs are forwarded on to getData
"""
try:
return eval("self." + str(params['output_id']) + "(params)")
except AttributeError:
df = self.getData(params)
if df is None:
return None
return df.to_dict(orient='records')
|
python
|
def getJsonData(self, params):
"""turns the DataFrame returned by getData into a dictionary
arguments:
the params passed used for table or d3 outputs are forwarded on to getData
"""
try:
return eval("self." + str(params['output_id']) + "(params)")
except AttributeError:
df = self.getData(params)
if df is None:
return None
return df.to_dict(orient='records')
|
[
"def",
"getJsonData",
"(",
"self",
",",
"params",
")",
":",
"try",
":",
"return",
"eval",
"(",
"\"self.\"",
"+",
"str",
"(",
"params",
"[",
"'output_id'",
"]",
")",
"+",
"\"(params)\"",
")",
"except",
"AttributeError",
":",
"df",
"=",
"self",
".",
"getData",
"(",
"params",
")",
"if",
"df",
"is",
"None",
":",
"return",
"None",
"return",
"df",
".",
"to_dict",
"(",
"orient",
"=",
"'records'",
")"
] |
turns the DataFrame returned by getData into a dictionary
arguments:
the params passed used for table or d3 outputs are forwarded on to getData
|
[
"turns",
"the",
"DataFrame",
"returned",
"by",
"getData",
"into",
"a",
"dictionary"
] |
5dd9f6de072e99af636ab7e7393d249761c56e69
|
https://github.com/adamhajari/spyre/blob/5dd9f6de072e99af636ab7e7393d249761c56e69/spyre/server.py#L330-L342
|
train
|
adamhajari/spyre
|
spyre/server.py
|
App.launch_in_notebook
|
def launch_in_notebook(self, port=9095, width=900, height=600):
"""launch the app within an iframe in ipython notebook"""
from IPython.lib import backgroundjobs as bg
from IPython.display import HTML
jobs = bg.BackgroundJobManager()
jobs.new(self.launch, kw=dict(port=port))
frame = HTML(
'<iframe src=http://localhost:{} width={} height={}></iframe>'
.format(port, width, height)
)
return frame
|
python
|
def launch_in_notebook(self, port=9095, width=900, height=600):
"""launch the app within an iframe in ipython notebook"""
from IPython.lib import backgroundjobs as bg
from IPython.display import HTML
jobs = bg.BackgroundJobManager()
jobs.new(self.launch, kw=dict(port=port))
frame = HTML(
'<iframe src=http://localhost:{} width={} height={}></iframe>'
.format(port, width, height)
)
return frame
|
[
"def",
"launch_in_notebook",
"(",
"self",
",",
"port",
"=",
"9095",
",",
"width",
"=",
"900",
",",
"height",
"=",
"600",
")",
":",
"from",
"IPython",
".",
"lib",
"import",
"backgroundjobs",
"as",
"bg",
"from",
"IPython",
".",
"display",
"import",
"HTML",
"jobs",
"=",
"bg",
".",
"BackgroundJobManager",
"(",
")",
"jobs",
".",
"new",
"(",
"self",
".",
"launch",
",",
"kw",
"=",
"dict",
"(",
"port",
"=",
"port",
")",
")",
"frame",
"=",
"HTML",
"(",
"'<iframe src=http://localhost:{} width={} height={}></iframe>'",
".",
"format",
"(",
"port",
",",
"width",
",",
"height",
")",
")",
"return",
"frame"
] |
launch the app within an iframe in ipython notebook
|
[
"launch",
"the",
"app",
"within",
"an",
"iframe",
"in",
"ipython",
"notebook"
] |
5dd9f6de072e99af636ab7e7393d249761c56e69
|
https://github.com/adamhajari/spyre/blob/5dd9f6de072e99af636ab7e7393d249761c56e69/spyre/server.py#L469-L480
|
train
|
adamhajari/spyre
|
spyre/server.py
|
Site.launch
|
def launch(self, host="local", port=8080):
"""Calling the Launch method on a Site object will serve the top
node of the cherrypy Root object tree"""
# Need to add in the appbar if many apps
self.root.templateVars['app_bar'] = self.site_app_bar
for fullRoute, _ in self.site_app_bar[1:]:
parent, route = self.get_route(fullRoute)
parent.__dict__[route].templateVars['app_bar'] = self.site_app_bar
if host != "local":
cherrypy.server.socket_host = '0.0.0.0'
cherrypy.server.socket_port = port
cherrypy.quickstart(self.root)
|
python
|
def launch(self, host="local", port=8080):
"""Calling the Launch method on a Site object will serve the top
node of the cherrypy Root object tree"""
# Need to add in the appbar if many apps
self.root.templateVars['app_bar'] = self.site_app_bar
for fullRoute, _ in self.site_app_bar[1:]:
parent, route = self.get_route(fullRoute)
parent.__dict__[route].templateVars['app_bar'] = self.site_app_bar
if host != "local":
cherrypy.server.socket_host = '0.0.0.0'
cherrypy.server.socket_port = port
cherrypy.quickstart(self.root)
|
[
"def",
"launch",
"(",
"self",
",",
"host",
"=",
"\"local\"",
",",
"port",
"=",
"8080",
")",
":",
"# Need to add in the appbar if many apps",
"self",
".",
"root",
".",
"templateVars",
"[",
"'app_bar'",
"]",
"=",
"self",
".",
"site_app_bar",
"for",
"fullRoute",
",",
"_",
"in",
"self",
".",
"site_app_bar",
"[",
"1",
":",
"]",
":",
"parent",
",",
"route",
"=",
"self",
".",
"get_route",
"(",
"fullRoute",
")",
"parent",
".",
"__dict__",
"[",
"route",
"]",
".",
"templateVars",
"[",
"'app_bar'",
"]",
"=",
"self",
".",
"site_app_bar",
"if",
"host",
"!=",
"\"local\"",
":",
"cherrypy",
".",
"server",
".",
"socket_host",
"=",
"'0.0.0.0'",
"cherrypy",
".",
"server",
".",
"socket_port",
"=",
"port",
"cherrypy",
".",
"quickstart",
"(",
"self",
".",
"root",
")"
] |
Calling the Launch method on a Site object will serve the top
node of the cherrypy Root object tree
|
[
"Calling",
"the",
"Launch",
"method",
"on",
"a",
"Site",
"object",
"will",
"serve",
"the",
"top",
"node",
"of",
"the",
"cherrypy",
"Root",
"object",
"tree"
] |
5dd9f6de072e99af636ab7e7393d249761c56e69
|
https://github.com/adamhajari/spyre/blob/5dd9f6de072e99af636ab7e7393d249761c56e69/spyre/server.py#L552-L565
|
train
|
googlefonts/fontmake
|
Lib/fontmake/__main__.py
|
exclude_args
|
def exclude_args(parser, args, excluded_args, target):
"""Delete options that are not appropriate for a following code path; exit
with an error if excluded options were passed in by the user.
argparse generates a namespace with all options it knows, but not every
attribute should be passed to all code paths (i.e. options about
interpolation should not reach `run_from_ufos()`). This function can be run
before entering a particular code path to clean up the kwargs passed to it.
Exit with an error message if the user actually passed the options in.
"""
msg = '"%s" option invalid for %s'
for argname in excluded_args:
if argname not in args:
continue
if args[argname]:
optname = "--%s" % argname.replace("_", "-")
parser.error(msg % (optname, target))
del args[argname]
|
python
|
def exclude_args(parser, args, excluded_args, target):
"""Delete options that are not appropriate for a following code path; exit
with an error if excluded options were passed in by the user.
argparse generates a namespace with all options it knows, but not every
attribute should be passed to all code paths (i.e. options about
interpolation should not reach `run_from_ufos()`). This function can be run
before entering a particular code path to clean up the kwargs passed to it.
Exit with an error message if the user actually passed the options in.
"""
msg = '"%s" option invalid for %s'
for argname in excluded_args:
if argname not in args:
continue
if args[argname]:
optname = "--%s" % argname.replace("_", "-")
parser.error(msg % (optname, target))
del args[argname]
|
[
"def",
"exclude_args",
"(",
"parser",
",",
"args",
",",
"excluded_args",
",",
"target",
")",
":",
"msg",
"=",
"'\"%s\" option invalid for %s'",
"for",
"argname",
"in",
"excluded_args",
":",
"if",
"argname",
"not",
"in",
"args",
":",
"continue",
"if",
"args",
"[",
"argname",
"]",
":",
"optname",
"=",
"\"--%s\"",
"%",
"argname",
".",
"replace",
"(",
"\"_\"",
",",
"\"-\"",
")",
"parser",
".",
"error",
"(",
"msg",
"%",
"(",
"optname",
",",
"target",
")",
")",
"del",
"args",
"[",
"argname",
"]"
] |
Delete options that are not appropriate for a following code path; exit
with an error if excluded options were passed in by the user.
argparse generates a namespace with all options it knows, but not every
attribute should be passed to all code paths (i.e. options about
interpolation should not reach `run_from_ufos()`). This function can be run
before entering a particular code path to clean up the kwargs passed to it.
Exit with an error message if the user actually passed the options in.
|
[
"Delete",
"options",
"that",
"are",
"not",
"appropriate",
"for",
"a",
"following",
"code",
"path",
";",
"exit",
"with",
"an",
"error",
"if",
"excluded",
"options",
"were",
"passed",
"in",
"by",
"the",
"user",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/__main__.py#L42-L60
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
_varLib_finder
|
def _varLib_finder(source, directory="", ext="ttf"):
"""Finder function to be used with varLib.build to find master TTFs given
the filename of the source UFO master as specified in the designspace.
It replaces the UFO directory with the one specified in 'directory'
argument, and replaces the file extension with 'ext'.
"""
fname = os.path.splitext(os.path.basename(source))[0] + "." + ext
return os.path.join(directory, fname)
|
python
|
def _varLib_finder(source, directory="", ext="ttf"):
"""Finder function to be used with varLib.build to find master TTFs given
the filename of the source UFO master as specified in the designspace.
It replaces the UFO directory with the one specified in 'directory'
argument, and replaces the file extension with 'ext'.
"""
fname = os.path.splitext(os.path.basename(source))[0] + "." + ext
return os.path.join(directory, fname)
|
[
"def",
"_varLib_finder",
"(",
"source",
",",
"directory",
"=",
"\"\"",
",",
"ext",
"=",
"\"ttf\"",
")",
":",
"fname",
"=",
"os",
".",
"path",
".",
"splitext",
"(",
"os",
".",
"path",
".",
"basename",
"(",
"source",
")",
")",
"[",
"0",
"]",
"+",
"\".\"",
"+",
"ext",
"return",
"os",
".",
"path",
".",
"join",
"(",
"directory",
",",
"fname",
")"
] |
Finder function to be used with varLib.build to find master TTFs given
the filename of the source UFO master as specified in the designspace.
It replaces the UFO directory with the one specified in 'directory'
argument, and replaces the file extension with 'ext'.
|
[
"Finder",
"function",
"to",
"be",
"used",
"with",
"varLib",
".",
"build",
"to",
"find",
"master",
"TTFs",
"given",
"the",
"filename",
"of",
"the",
"source",
"UFO",
"master",
"as",
"specified",
"in",
"the",
"designspace",
".",
"It",
"replaces",
"the",
"UFO",
"directory",
"with",
"the",
"one",
"specified",
"in",
"directory",
"argument",
"and",
"replaces",
"the",
"file",
"extension",
"with",
"ext",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L1158-L1165
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject.build_master_ufos
|
def build_master_ufos(
self,
glyphs_path,
designspace_path=None,
master_dir=None,
instance_dir=None,
family_name=None,
mti_source=None,
):
"""Build UFOs and MutatorMath designspace from Glyphs source."""
import glyphsLib
if master_dir is None:
master_dir = self._output_dir("ufo")
if not os.path.isdir(master_dir):
os.mkdir(master_dir)
if instance_dir is None:
instance_dir = self._output_dir("ufo", is_instance=True)
if not os.path.isdir(instance_dir):
os.mkdir(instance_dir)
font = glyphsLib.GSFont(glyphs_path)
if designspace_path is not None:
designspace_dir = os.path.dirname(designspace_path)
else:
designspace_dir = master_dir
# glyphsLib.to_designspace expects instance_dir to be relative
instance_dir = os.path.relpath(instance_dir, designspace_dir)
designspace = glyphsLib.to_designspace(
font, family_name=family_name, instance_dir=instance_dir
)
masters = {}
# multiple sources can have the same font/filename (but different layer),
# we want to save a font only once
for source in designspace.sources:
if source.filename in masters:
assert source.font is masters[source.filename]
continue
ufo_path = os.path.join(master_dir, source.filename)
# no need to also set the relative 'filename' attribute as that
# will be auto-updated on writing the designspace document
source.path = ufo_path
source.font.save(ufo_path)
masters[source.filename] = source.font
if designspace_path is None:
designspace_path = os.path.join(master_dir, designspace.filename)
designspace.write(designspace_path)
if mti_source:
self.add_mti_features_to_master_ufos(mti_source, masters.values())
return designspace_path
|
python
|
def build_master_ufos(
self,
glyphs_path,
designspace_path=None,
master_dir=None,
instance_dir=None,
family_name=None,
mti_source=None,
):
"""Build UFOs and MutatorMath designspace from Glyphs source."""
import glyphsLib
if master_dir is None:
master_dir = self._output_dir("ufo")
if not os.path.isdir(master_dir):
os.mkdir(master_dir)
if instance_dir is None:
instance_dir = self._output_dir("ufo", is_instance=True)
if not os.path.isdir(instance_dir):
os.mkdir(instance_dir)
font = glyphsLib.GSFont(glyphs_path)
if designspace_path is not None:
designspace_dir = os.path.dirname(designspace_path)
else:
designspace_dir = master_dir
# glyphsLib.to_designspace expects instance_dir to be relative
instance_dir = os.path.relpath(instance_dir, designspace_dir)
designspace = glyphsLib.to_designspace(
font, family_name=family_name, instance_dir=instance_dir
)
masters = {}
# multiple sources can have the same font/filename (but different layer),
# we want to save a font only once
for source in designspace.sources:
if source.filename in masters:
assert source.font is masters[source.filename]
continue
ufo_path = os.path.join(master_dir, source.filename)
# no need to also set the relative 'filename' attribute as that
# will be auto-updated on writing the designspace document
source.path = ufo_path
source.font.save(ufo_path)
masters[source.filename] = source.font
if designspace_path is None:
designspace_path = os.path.join(master_dir, designspace.filename)
designspace.write(designspace_path)
if mti_source:
self.add_mti_features_to_master_ufos(mti_source, masters.values())
return designspace_path
|
[
"def",
"build_master_ufos",
"(",
"self",
",",
"glyphs_path",
",",
"designspace_path",
"=",
"None",
",",
"master_dir",
"=",
"None",
",",
"instance_dir",
"=",
"None",
",",
"family_name",
"=",
"None",
",",
"mti_source",
"=",
"None",
",",
")",
":",
"import",
"glyphsLib",
"if",
"master_dir",
"is",
"None",
":",
"master_dir",
"=",
"self",
".",
"_output_dir",
"(",
"\"ufo\"",
")",
"if",
"not",
"os",
".",
"path",
".",
"isdir",
"(",
"master_dir",
")",
":",
"os",
".",
"mkdir",
"(",
"master_dir",
")",
"if",
"instance_dir",
"is",
"None",
":",
"instance_dir",
"=",
"self",
".",
"_output_dir",
"(",
"\"ufo\"",
",",
"is_instance",
"=",
"True",
")",
"if",
"not",
"os",
".",
"path",
".",
"isdir",
"(",
"instance_dir",
")",
":",
"os",
".",
"mkdir",
"(",
"instance_dir",
")",
"font",
"=",
"glyphsLib",
".",
"GSFont",
"(",
"glyphs_path",
")",
"if",
"designspace_path",
"is",
"not",
"None",
":",
"designspace_dir",
"=",
"os",
".",
"path",
".",
"dirname",
"(",
"designspace_path",
")",
"else",
":",
"designspace_dir",
"=",
"master_dir",
"# glyphsLib.to_designspace expects instance_dir to be relative",
"instance_dir",
"=",
"os",
".",
"path",
".",
"relpath",
"(",
"instance_dir",
",",
"designspace_dir",
")",
"designspace",
"=",
"glyphsLib",
".",
"to_designspace",
"(",
"font",
",",
"family_name",
"=",
"family_name",
",",
"instance_dir",
"=",
"instance_dir",
")",
"masters",
"=",
"{",
"}",
"# multiple sources can have the same font/filename (but different layer),",
"# we want to save a font only once",
"for",
"source",
"in",
"designspace",
".",
"sources",
":",
"if",
"source",
".",
"filename",
"in",
"masters",
":",
"assert",
"source",
".",
"font",
"is",
"masters",
"[",
"source",
".",
"filename",
"]",
"continue",
"ufo_path",
"=",
"os",
".",
"path",
".",
"join",
"(",
"master_dir",
",",
"source",
".",
"filename",
")",
"# no need to also set the relative 'filename' attribute as that",
"# will be auto-updated on writing the designspace document",
"source",
".",
"path",
"=",
"ufo_path",
"source",
".",
"font",
".",
"save",
"(",
"ufo_path",
")",
"masters",
"[",
"source",
".",
"filename",
"]",
"=",
"source",
".",
"font",
"if",
"designspace_path",
"is",
"None",
":",
"designspace_path",
"=",
"os",
".",
"path",
".",
"join",
"(",
"master_dir",
",",
"designspace",
".",
"filename",
")",
"designspace",
".",
"write",
"(",
"designspace_path",
")",
"if",
"mti_source",
":",
"self",
".",
"add_mti_features_to_master_ufos",
"(",
"mti_source",
",",
"masters",
".",
"values",
"(",
")",
")",
"return",
"designspace_path"
] |
Build UFOs and MutatorMath designspace from Glyphs source.
|
[
"Build",
"UFOs",
"and",
"MutatorMath",
"designspace",
"from",
"Glyphs",
"source",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L110-L163
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject.remove_overlaps
|
def remove_overlaps(self, ufos, glyph_filter=lambda g: len(g)):
"""Remove overlaps in UFOs' glyphs' contours."""
from booleanOperations import union, BooleanOperationsError
for ufo in ufos:
font_name = self._font_name(ufo)
logger.info("Removing overlaps for " + font_name)
for glyph in ufo:
if not glyph_filter(glyph):
continue
contours = list(glyph)
glyph.clearContours()
try:
union(contours, glyph.getPointPen())
except BooleanOperationsError:
logger.error(
"Failed to remove overlaps for %s: %r", font_name, glyph.name
)
raise
|
python
|
def remove_overlaps(self, ufos, glyph_filter=lambda g: len(g)):
"""Remove overlaps in UFOs' glyphs' contours."""
from booleanOperations import union, BooleanOperationsError
for ufo in ufos:
font_name = self._font_name(ufo)
logger.info("Removing overlaps for " + font_name)
for glyph in ufo:
if not glyph_filter(glyph):
continue
contours = list(glyph)
glyph.clearContours()
try:
union(contours, glyph.getPointPen())
except BooleanOperationsError:
logger.error(
"Failed to remove overlaps for %s: %r", font_name, glyph.name
)
raise
|
[
"def",
"remove_overlaps",
"(",
"self",
",",
"ufos",
",",
"glyph_filter",
"=",
"lambda",
"g",
":",
"len",
"(",
"g",
")",
")",
":",
"from",
"booleanOperations",
"import",
"union",
",",
"BooleanOperationsError",
"for",
"ufo",
"in",
"ufos",
":",
"font_name",
"=",
"self",
".",
"_font_name",
"(",
"ufo",
")",
"logger",
".",
"info",
"(",
"\"Removing overlaps for \"",
"+",
"font_name",
")",
"for",
"glyph",
"in",
"ufo",
":",
"if",
"not",
"glyph_filter",
"(",
"glyph",
")",
":",
"continue",
"contours",
"=",
"list",
"(",
"glyph",
")",
"glyph",
".",
"clearContours",
"(",
")",
"try",
":",
"union",
"(",
"contours",
",",
"glyph",
".",
"getPointPen",
"(",
")",
")",
"except",
"BooleanOperationsError",
":",
"logger",
".",
"error",
"(",
"\"Failed to remove overlaps for %s: %r\"",
",",
"font_name",
",",
"glyph",
".",
"name",
")",
"raise"
] |
Remove overlaps in UFOs' glyphs' contours.
|
[
"Remove",
"overlaps",
"in",
"UFOs",
"glyphs",
"contours",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L187-L205
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject.decompose_glyphs
|
def decompose_glyphs(self, ufos, glyph_filter=lambda g: True):
"""Move components of UFOs' glyphs to their outlines."""
for ufo in ufos:
logger.info("Decomposing glyphs for " + self._font_name(ufo))
for glyph in ufo:
if not glyph.components or not glyph_filter(glyph):
continue
self._deep_copy_contours(ufo, glyph, glyph, Transform())
glyph.clearComponents()
|
python
|
def decompose_glyphs(self, ufos, glyph_filter=lambda g: True):
"""Move components of UFOs' glyphs to their outlines."""
for ufo in ufos:
logger.info("Decomposing glyphs for " + self._font_name(ufo))
for glyph in ufo:
if not glyph.components or not glyph_filter(glyph):
continue
self._deep_copy_contours(ufo, glyph, glyph, Transform())
glyph.clearComponents()
|
[
"def",
"decompose_glyphs",
"(",
"self",
",",
"ufos",
",",
"glyph_filter",
"=",
"lambda",
"g",
":",
"True",
")",
":",
"for",
"ufo",
"in",
"ufos",
":",
"logger",
".",
"info",
"(",
"\"Decomposing glyphs for \"",
"+",
"self",
".",
"_font_name",
"(",
"ufo",
")",
")",
"for",
"glyph",
"in",
"ufo",
":",
"if",
"not",
"glyph",
".",
"components",
"or",
"not",
"glyph_filter",
"(",
"glyph",
")",
":",
"continue",
"self",
".",
"_deep_copy_contours",
"(",
"ufo",
",",
"glyph",
",",
"glyph",
",",
"Transform",
"(",
")",
")",
"glyph",
".",
"clearComponents",
"(",
")"
] |
Move components of UFOs' glyphs to their outlines.
|
[
"Move",
"components",
"of",
"UFOs",
"glyphs",
"to",
"their",
"outlines",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L209-L218
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject.build_ttfs
|
def build_ttfs(self, ufos, **kwargs):
"""Build OpenType binaries with TrueType outlines."""
self.save_otfs(ufos, ttf=True, **kwargs)
|
python
|
def build_ttfs(self, ufos, **kwargs):
"""Build OpenType binaries with TrueType outlines."""
self.save_otfs(ufos, ttf=True, **kwargs)
|
[
"def",
"build_ttfs",
"(",
"self",
",",
"ufos",
",",
"*",
"*",
"kwargs",
")",
":",
"self",
".",
"save_otfs",
"(",
"ufos",
",",
"ttf",
"=",
"True",
",",
"*",
"*",
"kwargs",
")"
] |
Build OpenType binaries with TrueType outlines.
|
[
"Build",
"OpenType",
"binaries",
"with",
"TrueType",
"outlines",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L271-L273
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject.build_variable_font
|
def build_variable_font(
self,
designspace,
output_path=None,
output_dir=None,
master_bin_dir=None,
ttf=True,
):
"""Build OpenType variable font from masters in a designspace."""
assert not (output_path and output_dir), "mutually exclusive args"
ext = "ttf" if ttf else "otf"
if hasattr(designspace, "__fspath__"):
designspace = designspace.__fspath__()
if isinstance(designspace, basestring):
designspace = designspaceLib.DesignSpaceDocument.fromfile(designspace)
if master_bin_dir is None:
master_bin_dir = self._output_dir(ext, interpolatable=True)
finder = partial(_varLib_finder, directory=master_bin_dir)
else:
assert all(isinstance(s.font, TTFont) for s in designspace.sources)
finder = lambda s: s # noqa: E731
if output_path is None:
output_path = (
os.path.splitext(os.path.basename(designspace.path))[0] + "-VF"
)
output_path = self._output_path(
output_path, ext, is_variable=True, output_dir=output_dir
)
logger.info("Building variable font " + output_path)
font, _, _ = varLib.build(designspace, finder)
font.save(output_path)
|
python
|
def build_variable_font(
self,
designspace,
output_path=None,
output_dir=None,
master_bin_dir=None,
ttf=True,
):
"""Build OpenType variable font from masters in a designspace."""
assert not (output_path and output_dir), "mutually exclusive args"
ext = "ttf" if ttf else "otf"
if hasattr(designspace, "__fspath__"):
designspace = designspace.__fspath__()
if isinstance(designspace, basestring):
designspace = designspaceLib.DesignSpaceDocument.fromfile(designspace)
if master_bin_dir is None:
master_bin_dir = self._output_dir(ext, interpolatable=True)
finder = partial(_varLib_finder, directory=master_bin_dir)
else:
assert all(isinstance(s.font, TTFont) for s in designspace.sources)
finder = lambda s: s # noqa: E731
if output_path is None:
output_path = (
os.path.splitext(os.path.basename(designspace.path))[0] + "-VF"
)
output_path = self._output_path(
output_path, ext, is_variable=True, output_dir=output_dir
)
logger.info("Building variable font " + output_path)
font, _, _ = varLib.build(designspace, finder)
font.save(output_path)
|
[
"def",
"build_variable_font",
"(",
"self",
",",
"designspace",
",",
"output_path",
"=",
"None",
",",
"output_dir",
"=",
"None",
",",
"master_bin_dir",
"=",
"None",
",",
"ttf",
"=",
"True",
",",
")",
":",
"assert",
"not",
"(",
"output_path",
"and",
"output_dir",
")",
",",
"\"mutually exclusive args\"",
"ext",
"=",
"\"ttf\"",
"if",
"ttf",
"else",
"\"otf\"",
"if",
"hasattr",
"(",
"designspace",
",",
"\"__fspath__\"",
")",
":",
"designspace",
"=",
"designspace",
".",
"__fspath__",
"(",
")",
"if",
"isinstance",
"(",
"designspace",
",",
"basestring",
")",
":",
"designspace",
"=",
"designspaceLib",
".",
"DesignSpaceDocument",
".",
"fromfile",
"(",
"designspace",
")",
"if",
"master_bin_dir",
"is",
"None",
":",
"master_bin_dir",
"=",
"self",
".",
"_output_dir",
"(",
"ext",
",",
"interpolatable",
"=",
"True",
")",
"finder",
"=",
"partial",
"(",
"_varLib_finder",
",",
"directory",
"=",
"master_bin_dir",
")",
"else",
":",
"assert",
"all",
"(",
"isinstance",
"(",
"s",
".",
"font",
",",
"TTFont",
")",
"for",
"s",
"in",
"designspace",
".",
"sources",
")",
"finder",
"=",
"lambda",
"s",
":",
"s",
"# noqa: E731",
"if",
"output_path",
"is",
"None",
":",
"output_path",
"=",
"(",
"os",
".",
"path",
".",
"splitext",
"(",
"os",
".",
"path",
".",
"basename",
"(",
"designspace",
".",
"path",
")",
")",
"[",
"0",
"]",
"+",
"\"-VF\"",
")",
"output_path",
"=",
"self",
".",
"_output_path",
"(",
"output_path",
",",
"ext",
",",
"is_variable",
"=",
"True",
",",
"output_dir",
"=",
"output_dir",
")",
"logger",
".",
"info",
"(",
"\"Building variable font \"",
"+",
"output_path",
")",
"font",
",",
"_",
",",
"_",
"=",
"varLib",
".",
"build",
"(",
"designspace",
",",
"finder",
")",
"font",
".",
"save",
"(",
"output_path",
")"
] |
Build OpenType variable font from masters in a designspace.
|
[
"Build",
"OpenType",
"variable",
"font",
"from",
"masters",
"in",
"a",
"designspace",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L341-L377
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject.subset_otf_from_ufo
|
def subset_otf_from_ufo(self, otf_path, ufo):
"""Subset a font using export flags set by glyphsLib.
There are two more settings that can change export behavior:
"Export Glyphs" and "Remove Glyphs", which are currently not supported
for complexity reasons. See
https://github.com/googlei18n/glyphsLib/issues/295.
"""
from fontTools import subset
# ufo2ft always inserts a ".notdef" glyph as the first glyph
ufo_order = makeOfficialGlyphOrder(ufo)
if ".notdef" not in ufo_order:
ufo_order.insert(0, ".notdef")
ot_order = TTFont(otf_path).getGlyphOrder()
assert ot_order[0] == ".notdef"
assert len(ufo_order) == len(ot_order)
for key in (KEEP_GLYPHS_NEW_KEY, KEEP_GLYPHS_OLD_KEY):
keep_glyphs_list = ufo.lib.get(key)
if keep_glyphs_list is not None:
keep_glyphs = set(keep_glyphs_list)
break
else:
keep_glyphs = None
include = []
for source_name, binary_name in zip(ufo_order, ot_order):
if keep_glyphs and source_name not in keep_glyphs:
continue
if source_name in ufo:
exported = ufo[source_name].lib.get(GLYPH_EXPORT_KEY, True)
if not exported:
continue
include.append(binary_name)
# copied from nototools.subset
opt = subset.Options()
opt.name_IDs = ["*"]
opt.name_legacy = True
opt.name_languages = ["*"]
opt.layout_features = ["*"]
opt.notdef_outline = True
opt.recalc_bounds = True
opt.recalc_timestamp = True
opt.canonical_order = True
opt.glyph_names = True
font = subset.load_font(otf_path, opt, lazy=False)
subsetter = subset.Subsetter(options=opt)
subsetter.populate(glyphs=include)
subsetter.subset(font)
subset.save_font(font, otf_path, opt)
|
python
|
def subset_otf_from_ufo(self, otf_path, ufo):
"""Subset a font using export flags set by glyphsLib.
There are two more settings that can change export behavior:
"Export Glyphs" and "Remove Glyphs", which are currently not supported
for complexity reasons. See
https://github.com/googlei18n/glyphsLib/issues/295.
"""
from fontTools import subset
# ufo2ft always inserts a ".notdef" glyph as the first glyph
ufo_order = makeOfficialGlyphOrder(ufo)
if ".notdef" not in ufo_order:
ufo_order.insert(0, ".notdef")
ot_order = TTFont(otf_path).getGlyphOrder()
assert ot_order[0] == ".notdef"
assert len(ufo_order) == len(ot_order)
for key in (KEEP_GLYPHS_NEW_KEY, KEEP_GLYPHS_OLD_KEY):
keep_glyphs_list = ufo.lib.get(key)
if keep_glyphs_list is not None:
keep_glyphs = set(keep_glyphs_list)
break
else:
keep_glyphs = None
include = []
for source_name, binary_name in zip(ufo_order, ot_order):
if keep_glyphs and source_name not in keep_glyphs:
continue
if source_name in ufo:
exported = ufo[source_name].lib.get(GLYPH_EXPORT_KEY, True)
if not exported:
continue
include.append(binary_name)
# copied from nototools.subset
opt = subset.Options()
opt.name_IDs = ["*"]
opt.name_legacy = True
opt.name_languages = ["*"]
opt.layout_features = ["*"]
opt.notdef_outline = True
opt.recalc_bounds = True
opt.recalc_timestamp = True
opt.canonical_order = True
opt.glyph_names = True
font = subset.load_font(otf_path, opt, lazy=False)
subsetter = subset.Subsetter(options=opt)
subsetter.populate(glyphs=include)
subsetter.subset(font)
subset.save_font(font, otf_path, opt)
|
[
"def",
"subset_otf_from_ufo",
"(",
"self",
",",
"otf_path",
",",
"ufo",
")",
":",
"from",
"fontTools",
"import",
"subset",
"# ufo2ft always inserts a \".notdef\" glyph as the first glyph",
"ufo_order",
"=",
"makeOfficialGlyphOrder",
"(",
"ufo",
")",
"if",
"\".notdef\"",
"not",
"in",
"ufo_order",
":",
"ufo_order",
".",
"insert",
"(",
"0",
",",
"\".notdef\"",
")",
"ot_order",
"=",
"TTFont",
"(",
"otf_path",
")",
".",
"getGlyphOrder",
"(",
")",
"assert",
"ot_order",
"[",
"0",
"]",
"==",
"\".notdef\"",
"assert",
"len",
"(",
"ufo_order",
")",
"==",
"len",
"(",
"ot_order",
")",
"for",
"key",
"in",
"(",
"KEEP_GLYPHS_NEW_KEY",
",",
"KEEP_GLYPHS_OLD_KEY",
")",
":",
"keep_glyphs_list",
"=",
"ufo",
".",
"lib",
".",
"get",
"(",
"key",
")",
"if",
"keep_glyphs_list",
"is",
"not",
"None",
":",
"keep_glyphs",
"=",
"set",
"(",
"keep_glyphs_list",
")",
"break",
"else",
":",
"keep_glyphs",
"=",
"None",
"include",
"=",
"[",
"]",
"for",
"source_name",
",",
"binary_name",
"in",
"zip",
"(",
"ufo_order",
",",
"ot_order",
")",
":",
"if",
"keep_glyphs",
"and",
"source_name",
"not",
"in",
"keep_glyphs",
":",
"continue",
"if",
"source_name",
"in",
"ufo",
":",
"exported",
"=",
"ufo",
"[",
"source_name",
"]",
".",
"lib",
".",
"get",
"(",
"GLYPH_EXPORT_KEY",
",",
"True",
")",
"if",
"not",
"exported",
":",
"continue",
"include",
".",
"append",
"(",
"binary_name",
")",
"# copied from nototools.subset",
"opt",
"=",
"subset",
".",
"Options",
"(",
")",
"opt",
".",
"name_IDs",
"=",
"[",
"\"*\"",
"]",
"opt",
".",
"name_legacy",
"=",
"True",
"opt",
".",
"name_languages",
"=",
"[",
"\"*\"",
"]",
"opt",
".",
"layout_features",
"=",
"[",
"\"*\"",
"]",
"opt",
".",
"notdef_outline",
"=",
"True",
"opt",
".",
"recalc_bounds",
"=",
"True",
"opt",
".",
"recalc_timestamp",
"=",
"True",
"opt",
".",
"canonical_order",
"=",
"True",
"opt",
".",
"glyph_names",
"=",
"True",
"font",
"=",
"subset",
".",
"load_font",
"(",
"otf_path",
",",
"opt",
",",
"lazy",
"=",
"False",
")",
"subsetter",
"=",
"subset",
".",
"Subsetter",
"(",
"options",
"=",
"opt",
")",
"subsetter",
".",
"populate",
"(",
"glyphs",
"=",
"include",
")",
"subsetter",
".",
"subset",
"(",
"font",
")",
"subset",
".",
"save_font",
"(",
"font",
",",
"otf_path",
",",
"opt",
")"
] |
Subset a font using export flags set by glyphsLib.
There are two more settings that can change export behavior:
"Export Glyphs" and "Remove Glyphs", which are currently not supported
for complexity reasons. See
https://github.com/googlei18n/glyphsLib/issues/295.
|
[
"Subset",
"a",
"font",
"using",
"export",
"flags",
"set",
"by",
"glyphsLib",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L625-L680
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject.run_from_glyphs
|
def run_from_glyphs(
self,
glyphs_path,
designspace_path=None,
master_dir=None,
instance_dir=None,
family_name=None,
mti_source=None,
**kwargs
):
"""Run toolchain from Glyphs source.
Args:
glyphs_path: Path to source file.
designspace_path: Output path of generated designspace document.
By default it's "<family_name>[-<base_style>].designspace".
master_dir: Directory where to save UFO masters (default:
"master_ufo").
instance_dir: Directory where to save UFO instances (default:
"instance_ufo").
family_name: If provided, uses this family name in the output.
mti_source: Path to property list file containing a dictionary
mapping UFO masters to dictionaries mapping layout table
tags to MTI source paths which should be compiled into
those tables.
kwargs: Arguments passed along to run_from_designspace.
"""
logger.info("Building master UFOs and designspace from Glyphs source")
designspace_path = self.build_master_ufos(
glyphs_path,
designspace_path=designspace_path,
master_dir=master_dir,
instance_dir=instance_dir,
family_name=family_name,
mti_source=mti_source,
)
self.run_from_designspace(designspace_path, **kwargs)
|
python
|
def run_from_glyphs(
self,
glyphs_path,
designspace_path=None,
master_dir=None,
instance_dir=None,
family_name=None,
mti_source=None,
**kwargs
):
"""Run toolchain from Glyphs source.
Args:
glyphs_path: Path to source file.
designspace_path: Output path of generated designspace document.
By default it's "<family_name>[-<base_style>].designspace".
master_dir: Directory where to save UFO masters (default:
"master_ufo").
instance_dir: Directory where to save UFO instances (default:
"instance_ufo").
family_name: If provided, uses this family name in the output.
mti_source: Path to property list file containing a dictionary
mapping UFO masters to dictionaries mapping layout table
tags to MTI source paths which should be compiled into
those tables.
kwargs: Arguments passed along to run_from_designspace.
"""
logger.info("Building master UFOs and designspace from Glyphs source")
designspace_path = self.build_master_ufos(
glyphs_path,
designspace_path=designspace_path,
master_dir=master_dir,
instance_dir=instance_dir,
family_name=family_name,
mti_source=mti_source,
)
self.run_from_designspace(designspace_path, **kwargs)
|
[
"def",
"run_from_glyphs",
"(",
"self",
",",
"glyphs_path",
",",
"designspace_path",
"=",
"None",
",",
"master_dir",
"=",
"None",
",",
"instance_dir",
"=",
"None",
",",
"family_name",
"=",
"None",
",",
"mti_source",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"logger",
".",
"info",
"(",
"\"Building master UFOs and designspace from Glyphs source\"",
")",
"designspace_path",
"=",
"self",
".",
"build_master_ufos",
"(",
"glyphs_path",
",",
"designspace_path",
"=",
"designspace_path",
",",
"master_dir",
"=",
"master_dir",
",",
"instance_dir",
"=",
"instance_dir",
",",
"family_name",
"=",
"family_name",
",",
"mti_source",
"=",
"mti_source",
",",
")",
"self",
".",
"run_from_designspace",
"(",
"designspace_path",
",",
"*",
"*",
"kwargs",
")"
] |
Run toolchain from Glyphs source.
Args:
glyphs_path: Path to source file.
designspace_path: Output path of generated designspace document.
By default it's "<family_name>[-<base_style>].designspace".
master_dir: Directory where to save UFO masters (default:
"master_ufo").
instance_dir: Directory where to save UFO instances (default:
"instance_ufo").
family_name: If provided, uses this family name in the output.
mti_source: Path to property list file containing a dictionary
mapping UFO masters to dictionaries mapping layout table
tags to MTI source paths which should be compiled into
those tables.
kwargs: Arguments passed along to run_from_designspace.
|
[
"Run",
"toolchain",
"from",
"Glyphs",
"source",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L682-L719
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject.interpolate_instance_ufos
|
def interpolate_instance_ufos(
self,
designspace,
include=None,
round_instances=False,
expand_features_to_instances=False,
):
"""Interpolate master UFOs with MutatorMath and return instance UFOs.
Args:
designspace: a DesignSpaceDocument object containing sources and
instances.
include (str): optional regular expression pattern to match the
DS instance 'name' attribute and only interpolate the matching
instances.
round_instances (bool): round instances' coordinates to integer.
expand_features_to_instances: parses the master feature file, expands all
include()s and writes the resulting full feature file to all instance
UFOs. Use this if you share feature files among masters in external
files. Otherwise, the relative include paths can break as instances
may end up elsewhere. Only done on interpolation.
Returns:
list of defcon.Font objects corresponding to the UFO instances.
Raises:
FontmakeError: if any of the sources defines a custom 'layer', for
this is not supported by MutatorMath.
ValueError: "expand_features_to_instances" is True but no source in the
designspace document is designated with '<features copy="1"/>'.
"""
from glyphsLib.interpolation import apply_instance_data
from mutatorMath.ufo.document import DesignSpaceDocumentReader
if any(source.layerName is not None for source in designspace.sources):
raise FontmakeError(
"MutatorMath doesn't support DesignSpace sources with 'layer' "
"attribute"
)
# TODO: replace mutatorMath with ufoProcessor?
builder = DesignSpaceDocumentReader(
designspace.path, ufoVersion=3, roundGeometry=round_instances, verbose=True
)
logger.info("Interpolating master UFOs from designspace")
if include is not None:
instances = self._search_instances(designspace, pattern=include)
for instance_name in instances:
builder.readInstance(("name", instance_name))
filenames = set(instances.values())
else:
builder.readInstances()
filenames = None # will include all instances
logger.info("Applying instance data from designspace")
instance_ufos = apply_instance_data(designspace, include_filenames=filenames)
if expand_features_to_instances:
logger.debug("Expanding features to instance UFOs")
master_source = next(
(s for s in designspace.sources if s.copyFeatures), None
)
if not master_source:
raise ValueError("No source is designated as the master for features.")
else:
master_source_font = builder.sources[master_source.name][0]
master_source_features = parseLayoutFeatures(master_source_font).asFea()
for instance_ufo in instance_ufos:
instance_ufo.features.text = master_source_features
instance_ufo.save()
return instance_ufos
|
python
|
def interpolate_instance_ufos(
self,
designspace,
include=None,
round_instances=False,
expand_features_to_instances=False,
):
"""Interpolate master UFOs with MutatorMath and return instance UFOs.
Args:
designspace: a DesignSpaceDocument object containing sources and
instances.
include (str): optional regular expression pattern to match the
DS instance 'name' attribute and only interpolate the matching
instances.
round_instances (bool): round instances' coordinates to integer.
expand_features_to_instances: parses the master feature file, expands all
include()s and writes the resulting full feature file to all instance
UFOs. Use this if you share feature files among masters in external
files. Otherwise, the relative include paths can break as instances
may end up elsewhere. Only done on interpolation.
Returns:
list of defcon.Font objects corresponding to the UFO instances.
Raises:
FontmakeError: if any of the sources defines a custom 'layer', for
this is not supported by MutatorMath.
ValueError: "expand_features_to_instances" is True but no source in the
designspace document is designated with '<features copy="1"/>'.
"""
from glyphsLib.interpolation import apply_instance_data
from mutatorMath.ufo.document import DesignSpaceDocumentReader
if any(source.layerName is not None for source in designspace.sources):
raise FontmakeError(
"MutatorMath doesn't support DesignSpace sources with 'layer' "
"attribute"
)
# TODO: replace mutatorMath with ufoProcessor?
builder = DesignSpaceDocumentReader(
designspace.path, ufoVersion=3, roundGeometry=round_instances, verbose=True
)
logger.info("Interpolating master UFOs from designspace")
if include is not None:
instances = self._search_instances(designspace, pattern=include)
for instance_name in instances:
builder.readInstance(("name", instance_name))
filenames = set(instances.values())
else:
builder.readInstances()
filenames = None # will include all instances
logger.info("Applying instance data from designspace")
instance_ufos = apply_instance_data(designspace, include_filenames=filenames)
if expand_features_to_instances:
logger.debug("Expanding features to instance UFOs")
master_source = next(
(s for s in designspace.sources if s.copyFeatures), None
)
if not master_source:
raise ValueError("No source is designated as the master for features.")
else:
master_source_font = builder.sources[master_source.name][0]
master_source_features = parseLayoutFeatures(master_source_font).asFea()
for instance_ufo in instance_ufos:
instance_ufo.features.text = master_source_features
instance_ufo.save()
return instance_ufos
|
[
"def",
"interpolate_instance_ufos",
"(",
"self",
",",
"designspace",
",",
"include",
"=",
"None",
",",
"round_instances",
"=",
"False",
",",
"expand_features_to_instances",
"=",
"False",
",",
")",
":",
"from",
"glyphsLib",
".",
"interpolation",
"import",
"apply_instance_data",
"from",
"mutatorMath",
".",
"ufo",
".",
"document",
"import",
"DesignSpaceDocumentReader",
"if",
"any",
"(",
"source",
".",
"layerName",
"is",
"not",
"None",
"for",
"source",
"in",
"designspace",
".",
"sources",
")",
":",
"raise",
"FontmakeError",
"(",
"\"MutatorMath doesn't support DesignSpace sources with 'layer' \"",
"\"attribute\"",
")",
"# TODO: replace mutatorMath with ufoProcessor?",
"builder",
"=",
"DesignSpaceDocumentReader",
"(",
"designspace",
".",
"path",
",",
"ufoVersion",
"=",
"3",
",",
"roundGeometry",
"=",
"round_instances",
",",
"verbose",
"=",
"True",
")",
"logger",
".",
"info",
"(",
"\"Interpolating master UFOs from designspace\"",
")",
"if",
"include",
"is",
"not",
"None",
":",
"instances",
"=",
"self",
".",
"_search_instances",
"(",
"designspace",
",",
"pattern",
"=",
"include",
")",
"for",
"instance_name",
"in",
"instances",
":",
"builder",
".",
"readInstance",
"(",
"(",
"\"name\"",
",",
"instance_name",
")",
")",
"filenames",
"=",
"set",
"(",
"instances",
".",
"values",
"(",
")",
")",
"else",
":",
"builder",
".",
"readInstances",
"(",
")",
"filenames",
"=",
"None",
"# will include all instances",
"logger",
".",
"info",
"(",
"\"Applying instance data from designspace\"",
")",
"instance_ufos",
"=",
"apply_instance_data",
"(",
"designspace",
",",
"include_filenames",
"=",
"filenames",
")",
"if",
"expand_features_to_instances",
":",
"logger",
".",
"debug",
"(",
"\"Expanding features to instance UFOs\"",
")",
"master_source",
"=",
"next",
"(",
"(",
"s",
"for",
"s",
"in",
"designspace",
".",
"sources",
"if",
"s",
".",
"copyFeatures",
")",
",",
"None",
")",
"if",
"not",
"master_source",
":",
"raise",
"ValueError",
"(",
"\"No source is designated as the master for features.\"",
")",
"else",
":",
"master_source_font",
"=",
"builder",
".",
"sources",
"[",
"master_source",
".",
"name",
"]",
"[",
"0",
"]",
"master_source_features",
"=",
"parseLayoutFeatures",
"(",
"master_source_font",
")",
".",
"asFea",
"(",
")",
"for",
"instance_ufo",
"in",
"instance_ufos",
":",
"instance_ufo",
".",
"features",
".",
"text",
"=",
"master_source_features",
"instance_ufo",
".",
"save",
"(",
")",
"return",
"instance_ufos"
] |
Interpolate master UFOs with MutatorMath and return instance UFOs.
Args:
designspace: a DesignSpaceDocument object containing sources and
instances.
include (str): optional regular expression pattern to match the
DS instance 'name' attribute and only interpolate the matching
instances.
round_instances (bool): round instances' coordinates to integer.
expand_features_to_instances: parses the master feature file, expands all
include()s and writes the resulting full feature file to all instance
UFOs. Use this if you share feature files among masters in external
files. Otherwise, the relative include paths can break as instances
may end up elsewhere. Only done on interpolation.
Returns:
list of defcon.Font objects corresponding to the UFO instances.
Raises:
FontmakeError: if any of the sources defines a custom 'layer', for
this is not supported by MutatorMath.
ValueError: "expand_features_to_instances" is True but no source in the
designspace document is designated with '<features copy="1"/>'.
|
[
"Interpolate",
"master",
"UFOs",
"with",
"MutatorMath",
"and",
"return",
"instance",
"UFOs",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L721-L789
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject.run_from_ufos
|
def run_from_ufos(self, ufos, output=(), **kwargs):
"""Run toolchain from UFO sources.
Args:
ufos: List of UFO sources, as either paths or opened objects.
output: List of output formats to generate.
kwargs: Arguments passed along to save_otfs.
"""
if set(output) == {"ufo"}:
return
# the `ufos` parameter can be a list of UFO objects
# or it can be a path (string) with a glob syntax
ufo_paths = []
if isinstance(ufos, basestring):
ufo_paths = glob.glob(ufos)
ufos = [Font(x) for x in ufo_paths]
elif isinstance(ufos, list):
# ufos can be either paths or open Font objects, so normalize them
ufos = [Font(x) if isinstance(x, basestring) else x for x in ufos]
ufo_paths = [x.path for x in ufos]
else:
raise FontmakeError(
"UFOs parameter is neither a defcon.Font object, a path or a glob, "
"nor a list of any of these.",
ufos,
)
need_reload = False
if "otf" in output:
self.build_otfs(ufos, **kwargs)
need_reload = True
if "ttf" in output:
if need_reload:
ufos = [Font(path) for path in ufo_paths]
self.build_ttfs(ufos, **kwargs)
need_reload = True
|
python
|
def run_from_ufos(self, ufos, output=(), **kwargs):
"""Run toolchain from UFO sources.
Args:
ufos: List of UFO sources, as either paths or opened objects.
output: List of output formats to generate.
kwargs: Arguments passed along to save_otfs.
"""
if set(output) == {"ufo"}:
return
# the `ufos` parameter can be a list of UFO objects
# or it can be a path (string) with a glob syntax
ufo_paths = []
if isinstance(ufos, basestring):
ufo_paths = glob.glob(ufos)
ufos = [Font(x) for x in ufo_paths]
elif isinstance(ufos, list):
# ufos can be either paths or open Font objects, so normalize them
ufos = [Font(x) if isinstance(x, basestring) else x for x in ufos]
ufo_paths = [x.path for x in ufos]
else:
raise FontmakeError(
"UFOs parameter is neither a defcon.Font object, a path or a glob, "
"nor a list of any of these.",
ufos,
)
need_reload = False
if "otf" in output:
self.build_otfs(ufos, **kwargs)
need_reload = True
if "ttf" in output:
if need_reload:
ufos = [Font(path) for path in ufo_paths]
self.build_ttfs(ufos, **kwargs)
need_reload = True
|
[
"def",
"run_from_ufos",
"(",
"self",
",",
"ufos",
",",
"output",
"=",
"(",
")",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"set",
"(",
"output",
")",
"==",
"{",
"\"ufo\"",
"}",
":",
"return",
"# the `ufos` parameter can be a list of UFO objects",
"# or it can be a path (string) with a glob syntax",
"ufo_paths",
"=",
"[",
"]",
"if",
"isinstance",
"(",
"ufos",
",",
"basestring",
")",
":",
"ufo_paths",
"=",
"glob",
".",
"glob",
"(",
"ufos",
")",
"ufos",
"=",
"[",
"Font",
"(",
"x",
")",
"for",
"x",
"in",
"ufo_paths",
"]",
"elif",
"isinstance",
"(",
"ufos",
",",
"list",
")",
":",
"# ufos can be either paths or open Font objects, so normalize them",
"ufos",
"=",
"[",
"Font",
"(",
"x",
")",
"if",
"isinstance",
"(",
"x",
",",
"basestring",
")",
"else",
"x",
"for",
"x",
"in",
"ufos",
"]",
"ufo_paths",
"=",
"[",
"x",
".",
"path",
"for",
"x",
"in",
"ufos",
"]",
"else",
":",
"raise",
"FontmakeError",
"(",
"\"UFOs parameter is neither a defcon.Font object, a path or a glob, \"",
"\"nor a list of any of these.\"",
",",
"ufos",
",",
")",
"need_reload",
"=",
"False",
"if",
"\"otf\"",
"in",
"output",
":",
"self",
".",
"build_otfs",
"(",
"ufos",
",",
"*",
"*",
"kwargs",
")",
"need_reload",
"=",
"True",
"if",
"\"ttf\"",
"in",
"output",
":",
"if",
"need_reload",
":",
"ufos",
"=",
"[",
"Font",
"(",
"path",
")",
"for",
"path",
"in",
"ufo_paths",
"]",
"self",
".",
"build_ttfs",
"(",
"ufos",
",",
"*",
"*",
"kwargs",
")",
"need_reload",
"=",
"True"
] |
Run toolchain from UFO sources.
Args:
ufos: List of UFO sources, as either paths or opened objects.
output: List of output formats to generate.
kwargs: Arguments passed along to save_otfs.
|
[
"Run",
"toolchain",
"from",
"UFO",
"sources",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L943-L981
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject._font_name
|
def _font_name(self, ufo):
"""Generate a postscript-style font name."""
family_name = (
ufo.info.familyName.replace(" ", "")
if ufo.info.familyName is not None
else "None"
)
style_name = (
ufo.info.styleName.replace(" ", "")
if ufo.info.styleName is not None
else "None"
)
return "{}-{}".format(family_name, style_name)
|
python
|
def _font_name(self, ufo):
"""Generate a postscript-style font name."""
family_name = (
ufo.info.familyName.replace(" ", "")
if ufo.info.familyName is not None
else "None"
)
style_name = (
ufo.info.styleName.replace(" ", "")
if ufo.info.styleName is not None
else "None"
)
return "{}-{}".format(family_name, style_name)
|
[
"def",
"_font_name",
"(",
"self",
",",
"ufo",
")",
":",
"family_name",
"=",
"(",
"ufo",
".",
"info",
".",
"familyName",
".",
"replace",
"(",
"\" \"",
",",
"\"\"",
")",
"if",
"ufo",
".",
"info",
".",
"familyName",
"is",
"not",
"None",
"else",
"\"None\"",
")",
"style_name",
"=",
"(",
"ufo",
".",
"info",
".",
"styleName",
".",
"replace",
"(",
"\" \"",
",",
"\"\"",
")",
"if",
"ufo",
".",
"info",
".",
"styleName",
"is",
"not",
"None",
"else",
"\"None\"",
")",
"return",
"\"{}-{}\"",
".",
"format",
"(",
"family_name",
",",
"style_name",
")"
] |
Generate a postscript-style font name.
|
[
"Generate",
"a",
"postscript",
"-",
"style",
"font",
"name",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L994-L1006
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject._output_dir
|
def _output_dir(
self,
ext,
is_instance=False,
interpolatable=False,
autohinted=False,
is_variable=False,
):
"""Generate an output directory.
Args:
ext: extension string.
is_instance: The output is instance font or not.
interpolatable: The output is interpolatable or not.
autohinted: The output is autohinted or not.
is_variable: The output is variable font or not.
Return:
output directory string.
"""
assert not (is_variable and any([is_instance, interpolatable]))
# FIXME? Use user configurable destination folders.
if is_variable:
dir_prefix = "variable_"
elif is_instance:
dir_prefix = "instance_"
else:
dir_prefix = "master_"
dir_suffix = "_interpolatable" if interpolatable else ""
output_dir = dir_prefix + ext + dir_suffix
if autohinted:
output_dir = os.path.join("autohinted", output_dir)
return output_dir
|
python
|
def _output_dir(
self,
ext,
is_instance=False,
interpolatable=False,
autohinted=False,
is_variable=False,
):
"""Generate an output directory.
Args:
ext: extension string.
is_instance: The output is instance font or not.
interpolatable: The output is interpolatable or not.
autohinted: The output is autohinted or not.
is_variable: The output is variable font or not.
Return:
output directory string.
"""
assert not (is_variable and any([is_instance, interpolatable]))
# FIXME? Use user configurable destination folders.
if is_variable:
dir_prefix = "variable_"
elif is_instance:
dir_prefix = "instance_"
else:
dir_prefix = "master_"
dir_suffix = "_interpolatable" if interpolatable else ""
output_dir = dir_prefix + ext + dir_suffix
if autohinted:
output_dir = os.path.join("autohinted", output_dir)
return output_dir
|
[
"def",
"_output_dir",
"(",
"self",
",",
"ext",
",",
"is_instance",
"=",
"False",
",",
"interpolatable",
"=",
"False",
",",
"autohinted",
"=",
"False",
",",
"is_variable",
"=",
"False",
",",
")",
":",
"assert",
"not",
"(",
"is_variable",
"and",
"any",
"(",
"[",
"is_instance",
",",
"interpolatable",
"]",
")",
")",
"# FIXME? Use user configurable destination folders.",
"if",
"is_variable",
":",
"dir_prefix",
"=",
"\"variable_\"",
"elif",
"is_instance",
":",
"dir_prefix",
"=",
"\"instance_\"",
"else",
":",
"dir_prefix",
"=",
"\"master_\"",
"dir_suffix",
"=",
"\"_interpolatable\"",
"if",
"interpolatable",
"else",
"\"\"",
"output_dir",
"=",
"dir_prefix",
"+",
"ext",
"+",
"dir_suffix",
"if",
"autohinted",
":",
"output_dir",
"=",
"os",
".",
"path",
".",
"join",
"(",
"\"autohinted\"",
",",
"output_dir",
")",
"return",
"output_dir"
] |
Generate an output directory.
Args:
ext: extension string.
is_instance: The output is instance font or not.
interpolatable: The output is interpolatable or not.
autohinted: The output is autohinted or not.
is_variable: The output is variable font or not.
Return:
output directory string.
|
[
"Generate",
"an",
"output",
"directory",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L1008-L1040
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject._output_path
|
def _output_path(
self,
ufo_or_font_name,
ext,
is_instance=False,
interpolatable=False,
autohinted=False,
is_variable=False,
output_dir=None,
suffix=None,
):
"""Generate output path for a font file with given extension."""
if isinstance(ufo_or_font_name, basestring):
font_name = ufo_or_font_name
elif ufo_or_font_name.path:
font_name = os.path.splitext(
os.path.basename(os.path.normpath(ufo_or_font_name.path))
)[0]
else:
font_name = self._font_name(ufo_or_font_name)
if output_dir is None:
output_dir = self._output_dir(
ext, is_instance, interpolatable, autohinted, is_variable
)
if not os.path.exists(output_dir):
os.makedirs(output_dir)
if suffix:
return os.path.join(output_dir, "{}-{}.{}".format(font_name, suffix, ext))
else:
return os.path.join(output_dir, "{}.{}".format(font_name, ext))
|
python
|
def _output_path(
self,
ufo_or_font_name,
ext,
is_instance=False,
interpolatable=False,
autohinted=False,
is_variable=False,
output_dir=None,
suffix=None,
):
"""Generate output path for a font file with given extension."""
if isinstance(ufo_or_font_name, basestring):
font_name = ufo_or_font_name
elif ufo_or_font_name.path:
font_name = os.path.splitext(
os.path.basename(os.path.normpath(ufo_or_font_name.path))
)[0]
else:
font_name = self._font_name(ufo_or_font_name)
if output_dir is None:
output_dir = self._output_dir(
ext, is_instance, interpolatable, autohinted, is_variable
)
if not os.path.exists(output_dir):
os.makedirs(output_dir)
if suffix:
return os.path.join(output_dir, "{}-{}.{}".format(font_name, suffix, ext))
else:
return os.path.join(output_dir, "{}.{}".format(font_name, ext))
|
[
"def",
"_output_path",
"(",
"self",
",",
"ufo_or_font_name",
",",
"ext",
",",
"is_instance",
"=",
"False",
",",
"interpolatable",
"=",
"False",
",",
"autohinted",
"=",
"False",
",",
"is_variable",
"=",
"False",
",",
"output_dir",
"=",
"None",
",",
"suffix",
"=",
"None",
",",
")",
":",
"if",
"isinstance",
"(",
"ufo_or_font_name",
",",
"basestring",
")",
":",
"font_name",
"=",
"ufo_or_font_name",
"elif",
"ufo_or_font_name",
".",
"path",
":",
"font_name",
"=",
"os",
".",
"path",
".",
"splitext",
"(",
"os",
".",
"path",
".",
"basename",
"(",
"os",
".",
"path",
".",
"normpath",
"(",
"ufo_or_font_name",
".",
"path",
")",
")",
")",
"[",
"0",
"]",
"else",
":",
"font_name",
"=",
"self",
".",
"_font_name",
"(",
"ufo_or_font_name",
")",
"if",
"output_dir",
"is",
"None",
":",
"output_dir",
"=",
"self",
".",
"_output_dir",
"(",
"ext",
",",
"is_instance",
",",
"interpolatable",
",",
"autohinted",
",",
"is_variable",
")",
"if",
"not",
"os",
".",
"path",
".",
"exists",
"(",
"output_dir",
")",
":",
"os",
".",
"makedirs",
"(",
"output_dir",
")",
"if",
"suffix",
":",
"return",
"os",
".",
"path",
".",
"join",
"(",
"output_dir",
",",
"\"{}-{}.{}\"",
".",
"format",
"(",
"font_name",
",",
"suffix",
",",
"ext",
")",
")",
"else",
":",
"return",
"os",
".",
"path",
".",
"join",
"(",
"output_dir",
",",
"\"{}.{}\"",
".",
"format",
"(",
"font_name",
",",
"ext",
")",
")"
] |
Generate output path for a font file with given extension.
|
[
"Generate",
"output",
"path",
"for",
"a",
"font",
"file",
"with",
"given",
"extension",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L1042-L1074
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject._designspace_locations
|
def _designspace_locations(self, designspace):
"""Map font filenames to their locations in a designspace."""
maps = []
for elements in (designspace.sources, designspace.instances):
location_map = {}
for element in elements:
path = _normpath(element.path)
location_map[path] = element.location
maps.append(location_map)
return maps
|
python
|
def _designspace_locations(self, designspace):
"""Map font filenames to their locations in a designspace."""
maps = []
for elements in (designspace.sources, designspace.instances):
location_map = {}
for element in elements:
path = _normpath(element.path)
location_map[path] = element.location
maps.append(location_map)
return maps
|
[
"def",
"_designspace_locations",
"(",
"self",
",",
"designspace",
")",
":",
"maps",
"=",
"[",
"]",
"for",
"elements",
"in",
"(",
"designspace",
".",
"sources",
",",
"designspace",
".",
"instances",
")",
":",
"location_map",
"=",
"{",
"}",
"for",
"element",
"in",
"elements",
":",
"path",
"=",
"_normpath",
"(",
"element",
".",
"path",
")",
"location_map",
"[",
"path",
"]",
"=",
"element",
".",
"location",
"maps",
".",
"append",
"(",
"location_map",
")",
"return",
"maps"
] |
Map font filenames to their locations in a designspace.
|
[
"Map",
"font",
"filenames",
"to",
"their",
"locations",
"in",
"a",
"designspace",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L1076-L1086
|
train
|
googlefonts/fontmake
|
Lib/fontmake/font_project.py
|
FontProject._closest_location
|
def _closest_location(self, location_map, target):
"""Return path of font whose location is closest to target."""
def dist(a, b):
return math.sqrt(sum((a[k] - b[k]) ** 2 for k in a.keys()))
paths = iter(location_map.keys())
closest = next(paths)
closest_dist = dist(target, location_map[closest])
for path in paths:
cur_dist = dist(target, location_map[path])
if cur_dist < closest_dist:
closest = path
closest_dist = cur_dist
return closest
|
python
|
def _closest_location(self, location_map, target):
"""Return path of font whose location is closest to target."""
def dist(a, b):
return math.sqrt(sum((a[k] - b[k]) ** 2 for k in a.keys()))
paths = iter(location_map.keys())
closest = next(paths)
closest_dist = dist(target, location_map[closest])
for path in paths:
cur_dist = dist(target, location_map[path])
if cur_dist < closest_dist:
closest = path
closest_dist = cur_dist
return closest
|
[
"def",
"_closest_location",
"(",
"self",
",",
"location_map",
",",
"target",
")",
":",
"def",
"dist",
"(",
"a",
",",
"b",
")",
":",
"return",
"math",
".",
"sqrt",
"(",
"sum",
"(",
"(",
"a",
"[",
"k",
"]",
"-",
"b",
"[",
"k",
"]",
")",
"**",
"2",
"for",
"k",
"in",
"a",
".",
"keys",
"(",
")",
")",
")",
"paths",
"=",
"iter",
"(",
"location_map",
".",
"keys",
"(",
")",
")",
"closest",
"=",
"next",
"(",
"paths",
")",
"closest_dist",
"=",
"dist",
"(",
"target",
",",
"location_map",
"[",
"closest",
"]",
")",
"for",
"path",
"in",
"paths",
":",
"cur_dist",
"=",
"dist",
"(",
"target",
",",
"location_map",
"[",
"path",
"]",
")",
"if",
"cur_dist",
"<",
"closest_dist",
":",
"closest",
"=",
"path",
"closest_dist",
"=",
"cur_dist",
"return",
"closest"
] |
Return path of font whose location is closest to target.
|
[
"Return",
"path",
"of",
"font",
"whose",
"location",
"is",
"closest",
"to",
"target",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/font_project.py#L1088-L1102
|
train
|
googlefonts/fontmake
|
Lib/fontmake/ttfautohint.py
|
ttfautohint
|
def ttfautohint(in_file, out_file, args=None, **kwargs):
"""Thin wrapper around the ttfautohint command line tool.
Can take in command line arguments directly as a string, or spelled out as
Python keyword arguments.
"""
arg_list = ["ttfautohint"]
file_args = [in_file, out_file]
if args is not None:
if kwargs:
raise TypeError("Should not provide both cmd args and kwargs.")
rv = subprocess.call(arg_list + args.split() + file_args)
if rv != 0:
raise TTFAError(rv)
return
boolean_options = (
"debug",
"composites",
"dehint",
"help",
"ignore_restrictions",
"detailed_info",
"no_info",
"adjust_subglyphs",
"symbol",
"ttfa_table",
"verbose",
"version",
"windows_compatibility",
)
other_options = (
"default_script",
"fallback_script",
"family_suffix",
"hinting_limit",
"fallback_stem_width",
"hinting_range_min",
"control_file",
"hinting_range_max",
"strong_stem_width",
"increase_x_height",
"x_height_snapping_exceptions",
)
for option in boolean_options:
if kwargs.pop(option, False):
arg_list.append("--" + option.replace("_", "-"))
for option in other_options:
arg = kwargs.pop(option, None)
if arg is not None:
arg_list.append("--{}={}".format(option.replace("_", "-"), arg))
if kwargs:
raise TypeError("Unexpected argument(s): " + ", ".join(kwargs.keys()))
rv = subprocess.call(arg_list + file_args)
if rv != 0:
raise TTFAError(rv)
|
python
|
def ttfautohint(in_file, out_file, args=None, **kwargs):
"""Thin wrapper around the ttfautohint command line tool.
Can take in command line arguments directly as a string, or spelled out as
Python keyword arguments.
"""
arg_list = ["ttfautohint"]
file_args = [in_file, out_file]
if args is not None:
if kwargs:
raise TypeError("Should not provide both cmd args and kwargs.")
rv = subprocess.call(arg_list + args.split() + file_args)
if rv != 0:
raise TTFAError(rv)
return
boolean_options = (
"debug",
"composites",
"dehint",
"help",
"ignore_restrictions",
"detailed_info",
"no_info",
"adjust_subglyphs",
"symbol",
"ttfa_table",
"verbose",
"version",
"windows_compatibility",
)
other_options = (
"default_script",
"fallback_script",
"family_suffix",
"hinting_limit",
"fallback_stem_width",
"hinting_range_min",
"control_file",
"hinting_range_max",
"strong_stem_width",
"increase_x_height",
"x_height_snapping_exceptions",
)
for option in boolean_options:
if kwargs.pop(option, False):
arg_list.append("--" + option.replace("_", "-"))
for option in other_options:
arg = kwargs.pop(option, None)
if arg is not None:
arg_list.append("--{}={}".format(option.replace("_", "-"), arg))
if kwargs:
raise TypeError("Unexpected argument(s): " + ", ".join(kwargs.keys()))
rv = subprocess.call(arg_list + file_args)
if rv != 0:
raise TTFAError(rv)
|
[
"def",
"ttfautohint",
"(",
"in_file",
",",
"out_file",
",",
"args",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"arg_list",
"=",
"[",
"\"ttfautohint\"",
"]",
"file_args",
"=",
"[",
"in_file",
",",
"out_file",
"]",
"if",
"args",
"is",
"not",
"None",
":",
"if",
"kwargs",
":",
"raise",
"TypeError",
"(",
"\"Should not provide both cmd args and kwargs.\"",
")",
"rv",
"=",
"subprocess",
".",
"call",
"(",
"arg_list",
"+",
"args",
".",
"split",
"(",
")",
"+",
"file_args",
")",
"if",
"rv",
"!=",
"0",
":",
"raise",
"TTFAError",
"(",
"rv",
")",
"return",
"boolean_options",
"=",
"(",
"\"debug\"",
",",
"\"composites\"",
",",
"\"dehint\"",
",",
"\"help\"",
",",
"\"ignore_restrictions\"",
",",
"\"detailed_info\"",
",",
"\"no_info\"",
",",
"\"adjust_subglyphs\"",
",",
"\"symbol\"",
",",
"\"ttfa_table\"",
",",
"\"verbose\"",
",",
"\"version\"",
",",
"\"windows_compatibility\"",
",",
")",
"other_options",
"=",
"(",
"\"default_script\"",
",",
"\"fallback_script\"",
",",
"\"family_suffix\"",
",",
"\"hinting_limit\"",
",",
"\"fallback_stem_width\"",
",",
"\"hinting_range_min\"",
",",
"\"control_file\"",
",",
"\"hinting_range_max\"",
",",
"\"strong_stem_width\"",
",",
"\"increase_x_height\"",
",",
"\"x_height_snapping_exceptions\"",
",",
")",
"for",
"option",
"in",
"boolean_options",
":",
"if",
"kwargs",
".",
"pop",
"(",
"option",
",",
"False",
")",
":",
"arg_list",
".",
"append",
"(",
"\"--\"",
"+",
"option",
".",
"replace",
"(",
"\"_\"",
",",
"\"-\"",
")",
")",
"for",
"option",
"in",
"other_options",
":",
"arg",
"=",
"kwargs",
".",
"pop",
"(",
"option",
",",
"None",
")",
"if",
"arg",
"is",
"not",
"None",
":",
"arg_list",
".",
"append",
"(",
"\"--{}={}\"",
".",
"format",
"(",
"option",
".",
"replace",
"(",
"\"_\"",
",",
"\"-\"",
")",
",",
"arg",
")",
")",
"if",
"kwargs",
":",
"raise",
"TypeError",
"(",
"\"Unexpected argument(s): \"",
"+",
"\", \"",
".",
"join",
"(",
"kwargs",
".",
"keys",
"(",
")",
")",
")",
"rv",
"=",
"subprocess",
".",
"call",
"(",
"arg_list",
"+",
"file_args",
")",
"if",
"rv",
"!=",
"0",
":",
"raise",
"TTFAError",
"(",
"rv",
")"
] |
Thin wrapper around the ttfautohint command line tool.
Can take in command line arguments directly as a string, or spelled out as
Python keyword arguments.
|
[
"Thin",
"wrapper",
"around",
"the",
"ttfautohint",
"command",
"line",
"tool",
"."
] |
b611baf49929575c2a30fd18662055365219ce2d
|
https://github.com/googlefonts/fontmake/blob/b611baf49929575c2a30fd18662055365219ce2d/Lib/fontmake/ttfautohint.py#L21-L82
|
train
|
ulule/python-logstash-formatter
|
logstash_formatter/__init__.py
|
_default_json_default
|
def _default_json_default(obj):
"""
Coerce everything to strings.
All objects representing time get output as ISO8601.
"""
if isinstance(obj, (datetime.datetime, datetime.date, datetime.time)):
return obj.isoformat()
else:
return str(obj)
|
python
|
def _default_json_default(obj):
"""
Coerce everything to strings.
All objects representing time get output as ISO8601.
"""
if isinstance(obj, (datetime.datetime, datetime.date, datetime.time)):
return obj.isoformat()
else:
return str(obj)
|
[
"def",
"_default_json_default",
"(",
"obj",
")",
":",
"if",
"isinstance",
"(",
"obj",
",",
"(",
"datetime",
".",
"datetime",
",",
"datetime",
".",
"date",
",",
"datetime",
".",
"time",
")",
")",
":",
"return",
"obj",
".",
"isoformat",
"(",
")",
"else",
":",
"return",
"str",
"(",
"obj",
")"
] |
Coerce everything to strings.
All objects representing time get output as ISO8601.
|
[
"Coerce",
"everything",
"to",
"strings",
".",
"All",
"objects",
"representing",
"time",
"get",
"output",
"as",
"ISO8601",
"."
] |
a29f7c8f5faec9467aaedfb74d5f40eacb2b50ea
|
https://github.com/ulule/python-logstash-formatter/blob/a29f7c8f5faec9467aaedfb74d5f40eacb2b50ea/logstash_formatter/__init__.py#L13-L21
|
train
|
ulule/python-logstash-formatter
|
logstash_formatter/__init__.py
|
LogstashFormatter.format
|
def format(self, record):
"""
Format a log record to JSON, if the message is a dict
assume an empty message and use the dict as additional
fields.
"""
fields = record.__dict__.copy()
if isinstance(record.msg, dict):
fields.update(record.msg)
fields.pop('msg')
msg = ""
else:
msg = record.getMessage()
try:
msg = msg.format(**fields)
except (KeyError, IndexError, ValueError):
pass
except:
# in case we can not format the msg properly we log it as is instead of crashing
msg = msg
if 'msg' in fields:
fields.pop('msg')
if 'exc_info' in fields:
if fields['exc_info']:
formatted = tb.format_exception(*fields['exc_info'])
fields['exception'] = formatted
fields.pop('exc_info')
if 'exc_text' in fields and not fields['exc_text']:
fields.pop('exc_text')
logr = self.defaults.copy()
logr.update({'@message': msg,
'@timestamp': datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%S.%fZ'),
'@source_host': self.source_host,
'@fields': self._build_fields(logr, fields)})
return json.dumps(logr, default=self.json_default, cls=self.json_cls)
|
python
|
def format(self, record):
"""
Format a log record to JSON, if the message is a dict
assume an empty message and use the dict as additional
fields.
"""
fields = record.__dict__.copy()
if isinstance(record.msg, dict):
fields.update(record.msg)
fields.pop('msg')
msg = ""
else:
msg = record.getMessage()
try:
msg = msg.format(**fields)
except (KeyError, IndexError, ValueError):
pass
except:
# in case we can not format the msg properly we log it as is instead of crashing
msg = msg
if 'msg' in fields:
fields.pop('msg')
if 'exc_info' in fields:
if fields['exc_info']:
formatted = tb.format_exception(*fields['exc_info'])
fields['exception'] = formatted
fields.pop('exc_info')
if 'exc_text' in fields and not fields['exc_text']:
fields.pop('exc_text')
logr = self.defaults.copy()
logr.update({'@message': msg,
'@timestamp': datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%S.%fZ'),
'@source_host': self.source_host,
'@fields': self._build_fields(logr, fields)})
return json.dumps(logr, default=self.json_default, cls=self.json_cls)
|
[
"def",
"format",
"(",
"self",
",",
"record",
")",
":",
"fields",
"=",
"record",
".",
"__dict__",
".",
"copy",
"(",
")",
"if",
"isinstance",
"(",
"record",
".",
"msg",
",",
"dict",
")",
":",
"fields",
".",
"update",
"(",
"record",
".",
"msg",
")",
"fields",
".",
"pop",
"(",
"'msg'",
")",
"msg",
"=",
"\"\"",
"else",
":",
"msg",
"=",
"record",
".",
"getMessage",
"(",
")",
"try",
":",
"msg",
"=",
"msg",
".",
"format",
"(",
"*",
"*",
"fields",
")",
"except",
"(",
"KeyError",
",",
"IndexError",
",",
"ValueError",
")",
":",
"pass",
"except",
":",
"# in case we can not format the msg properly we log it as is instead of crashing",
"msg",
"=",
"msg",
"if",
"'msg'",
"in",
"fields",
":",
"fields",
".",
"pop",
"(",
"'msg'",
")",
"if",
"'exc_info'",
"in",
"fields",
":",
"if",
"fields",
"[",
"'exc_info'",
"]",
":",
"formatted",
"=",
"tb",
".",
"format_exception",
"(",
"*",
"fields",
"[",
"'exc_info'",
"]",
")",
"fields",
"[",
"'exception'",
"]",
"=",
"formatted",
"fields",
".",
"pop",
"(",
"'exc_info'",
")",
"if",
"'exc_text'",
"in",
"fields",
"and",
"not",
"fields",
"[",
"'exc_text'",
"]",
":",
"fields",
".",
"pop",
"(",
"'exc_text'",
")",
"logr",
"=",
"self",
".",
"defaults",
".",
"copy",
"(",
")",
"logr",
".",
"update",
"(",
"{",
"'@message'",
":",
"msg",
",",
"'@timestamp'",
":",
"datetime",
".",
"datetime",
".",
"utcnow",
"(",
")",
".",
"strftime",
"(",
"'%Y-%m-%dT%H:%M:%S.%fZ'",
")",
",",
"'@source_host'",
":",
"self",
".",
"source_host",
",",
"'@fields'",
":",
"self",
".",
"_build_fields",
"(",
"logr",
",",
"fields",
")",
"}",
")",
"return",
"json",
".",
"dumps",
"(",
"logr",
",",
"default",
"=",
"self",
".",
"json_default",
",",
"cls",
"=",
"self",
".",
"json_cls",
")"
] |
Format a log record to JSON, if the message is a dict
assume an empty message and use the dict as additional
fields.
|
[
"Format",
"a",
"log",
"record",
"to",
"JSON",
"if",
"the",
"message",
"is",
"a",
"dict",
"assume",
"an",
"empty",
"message",
"and",
"use",
"the",
"dict",
"as",
"additional",
"fields",
"."
] |
a29f7c8f5faec9467aaedfb74d5f40eacb2b50ea
|
https://github.com/ulule/python-logstash-formatter/blob/a29f7c8f5faec9467aaedfb74d5f40eacb2b50ea/logstash_formatter/__init__.py#L65-L108
|
train
|
ulule/python-logstash-formatter
|
logstash_formatter/__init__.py
|
LogstashFormatter._build_fields
|
def _build_fields(self, defaults, fields):
"""Return provided fields including any in defaults
>>> f = LogstashFormatter()
# Verify that ``fields`` is used
>>> f._build_fields({}, {'foo': 'one'}) == \
{'foo': 'one'}
True
# Verify that ``@fields`` in ``defaults`` is used
>>> f._build_fields({'@fields': {'bar': 'two'}}, {'foo': 'one'}) == \
{'foo': 'one', 'bar': 'two'}
True
# Verify that ``fields`` takes precedence
>>> f._build_fields({'@fields': {'foo': 'two'}}, {'foo': 'one'}) == \
{'foo': 'one'}
True
"""
return dict(list(defaults.get('@fields', {}).items()) + list(fields.items()))
|
python
|
def _build_fields(self, defaults, fields):
"""Return provided fields including any in defaults
>>> f = LogstashFormatter()
# Verify that ``fields`` is used
>>> f._build_fields({}, {'foo': 'one'}) == \
{'foo': 'one'}
True
# Verify that ``@fields`` in ``defaults`` is used
>>> f._build_fields({'@fields': {'bar': 'two'}}, {'foo': 'one'}) == \
{'foo': 'one', 'bar': 'two'}
True
# Verify that ``fields`` takes precedence
>>> f._build_fields({'@fields': {'foo': 'two'}}, {'foo': 'one'}) == \
{'foo': 'one'}
True
"""
return dict(list(defaults.get('@fields', {}).items()) + list(fields.items()))
|
[
"def",
"_build_fields",
"(",
"self",
",",
"defaults",
",",
"fields",
")",
":",
"return",
"dict",
"(",
"list",
"(",
"defaults",
".",
"get",
"(",
"'@fields'",
",",
"{",
"}",
")",
".",
"items",
"(",
")",
")",
"+",
"list",
"(",
"fields",
".",
"items",
"(",
")",
")",
")"
] |
Return provided fields including any in defaults
>>> f = LogstashFormatter()
# Verify that ``fields`` is used
>>> f._build_fields({}, {'foo': 'one'}) == \
{'foo': 'one'}
True
# Verify that ``@fields`` in ``defaults`` is used
>>> f._build_fields({'@fields': {'bar': 'two'}}, {'foo': 'one'}) == \
{'foo': 'one', 'bar': 'two'}
True
# Verify that ``fields`` takes precedence
>>> f._build_fields({'@fields': {'foo': 'two'}}, {'foo': 'one'}) == \
{'foo': 'one'}
True
|
[
"Return",
"provided",
"fields",
"including",
"any",
"in",
"defaults"
] |
a29f7c8f5faec9467aaedfb74d5f40eacb2b50ea
|
https://github.com/ulule/python-logstash-formatter/blob/a29f7c8f5faec9467aaedfb74d5f40eacb2b50ea/logstash_formatter/__init__.py#L110-L127
|
train
|
tchellomello/python-arlo
|
pyarlo/__init__.py
|
PyArlo._authenticate
|
def _authenticate(self):
"""Authenticate user and generate token."""
self.cleanup_headers()
url = LOGIN_ENDPOINT
data = self.query(
url,
method='POST',
extra_params={
'email': self.__username,
'password': self.__password
})
if isinstance(data, dict) and data.get('success'):
data = data.get('data')
self.authenticated = data.get('authenticated')
self.country_code = data.get('countryCode')
self.date_created = data.get('dateCreated')
self.__token = data.get('token')
self.userid = data.get('userId')
# update header with the generated token
self.__headers['Authorization'] = self.__token
|
python
|
def _authenticate(self):
"""Authenticate user and generate token."""
self.cleanup_headers()
url = LOGIN_ENDPOINT
data = self.query(
url,
method='POST',
extra_params={
'email': self.__username,
'password': self.__password
})
if isinstance(data, dict) and data.get('success'):
data = data.get('data')
self.authenticated = data.get('authenticated')
self.country_code = data.get('countryCode')
self.date_created = data.get('dateCreated')
self.__token = data.get('token')
self.userid = data.get('userId')
# update header with the generated token
self.__headers['Authorization'] = self.__token
|
[
"def",
"_authenticate",
"(",
"self",
")",
":",
"self",
".",
"cleanup_headers",
"(",
")",
"url",
"=",
"LOGIN_ENDPOINT",
"data",
"=",
"self",
".",
"query",
"(",
"url",
",",
"method",
"=",
"'POST'",
",",
"extra_params",
"=",
"{",
"'email'",
":",
"self",
".",
"__username",
",",
"'password'",
":",
"self",
".",
"__password",
"}",
")",
"if",
"isinstance",
"(",
"data",
",",
"dict",
")",
"and",
"data",
".",
"get",
"(",
"'success'",
")",
":",
"data",
"=",
"data",
".",
"get",
"(",
"'data'",
")",
"self",
".",
"authenticated",
"=",
"data",
".",
"get",
"(",
"'authenticated'",
")",
"self",
".",
"country_code",
"=",
"data",
".",
"get",
"(",
"'countryCode'",
")",
"self",
".",
"date_created",
"=",
"data",
".",
"get",
"(",
"'dateCreated'",
")",
"self",
".",
"__token",
"=",
"data",
".",
"get",
"(",
"'token'",
")",
"self",
".",
"userid",
"=",
"data",
".",
"get",
"(",
"'userId'",
")",
"# update header with the generated token",
"self",
".",
"__headers",
"[",
"'Authorization'",
"]",
"=",
"self",
".",
"__token"
] |
Authenticate user and generate token.
|
[
"Authenticate",
"user",
"and",
"generate",
"token",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/__init__.py#L63-L84
|
train
|
tchellomello/python-arlo
|
pyarlo/__init__.py
|
PyArlo.cleanup_headers
|
def cleanup_headers(self):
"""Reset the headers and params."""
headers = {'Content-Type': 'application/json'}
headers['Authorization'] = self.__token
self.__headers = headers
self.__params = {}
|
python
|
def cleanup_headers(self):
"""Reset the headers and params."""
headers = {'Content-Type': 'application/json'}
headers['Authorization'] = self.__token
self.__headers = headers
self.__params = {}
|
[
"def",
"cleanup_headers",
"(",
"self",
")",
":",
"headers",
"=",
"{",
"'Content-Type'",
":",
"'application/json'",
"}",
"headers",
"[",
"'Authorization'",
"]",
"=",
"self",
".",
"__token",
"self",
".",
"__headers",
"=",
"headers",
"self",
".",
"__params",
"=",
"{",
"}"
] |
Reset the headers and params.
|
[
"Reset",
"the",
"headers",
"and",
"params",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/__init__.py#L86-L91
|
train
|
tchellomello/python-arlo
|
pyarlo/__init__.py
|
PyArlo.query
|
def query(self,
url,
method='GET',
extra_params=None,
extra_headers=None,
retry=3,
raw=False,
stream=False):
"""
Return a JSON object or raw session.
:param url: Arlo API URL
:param method: Specify the method GET, POST or PUT. Default is GET.
:param extra_params: Dictionary to be appended on request.body
:param extra_headers: Dictionary to be apppended on request.headers
:param retry: Attempts to retry a query. Default is 3.
:param raw: Boolean if query() will return request object instead JSON.
:param stream: Boolean if query() will return a stream object.
"""
response = None
loop = 0
# always make sure the headers and params are clean
self.cleanup_headers()
while loop <= retry:
# override request.body or request.headers dictionary
if extra_params:
params = self.__params
params.update(extra_params)
else:
params = self.__params
_LOGGER.debug("Params: %s", params)
if extra_headers:
headers = self.__headers
headers.update(extra_headers)
else:
headers = self.__headers
_LOGGER.debug("Headers: %s", headers)
_LOGGER.debug("Querying %s on attempt: %s/%s", url, loop, retry)
loop += 1
# define connection method
req = None
if method == 'GET':
req = self.session.get(url, headers=headers, stream=stream)
elif method == 'PUT':
req = self.session.put(url, json=params, headers=headers)
elif method == 'POST':
req = self.session.post(url, json=params, headers=headers)
if req and (req.status_code == 200):
if raw:
_LOGGER.debug("Required raw object.")
response = req
else:
response = req.json()
# leave if everything worked fine
break
return response
|
python
|
def query(self,
url,
method='GET',
extra_params=None,
extra_headers=None,
retry=3,
raw=False,
stream=False):
"""
Return a JSON object or raw session.
:param url: Arlo API URL
:param method: Specify the method GET, POST or PUT. Default is GET.
:param extra_params: Dictionary to be appended on request.body
:param extra_headers: Dictionary to be apppended on request.headers
:param retry: Attempts to retry a query. Default is 3.
:param raw: Boolean if query() will return request object instead JSON.
:param stream: Boolean if query() will return a stream object.
"""
response = None
loop = 0
# always make sure the headers and params are clean
self.cleanup_headers()
while loop <= retry:
# override request.body or request.headers dictionary
if extra_params:
params = self.__params
params.update(extra_params)
else:
params = self.__params
_LOGGER.debug("Params: %s", params)
if extra_headers:
headers = self.__headers
headers.update(extra_headers)
else:
headers = self.__headers
_LOGGER.debug("Headers: %s", headers)
_LOGGER.debug("Querying %s on attempt: %s/%s", url, loop, retry)
loop += 1
# define connection method
req = None
if method == 'GET':
req = self.session.get(url, headers=headers, stream=stream)
elif method == 'PUT':
req = self.session.put(url, json=params, headers=headers)
elif method == 'POST':
req = self.session.post(url, json=params, headers=headers)
if req and (req.status_code == 200):
if raw:
_LOGGER.debug("Required raw object.")
response = req
else:
response = req.json()
# leave if everything worked fine
break
return response
|
[
"def",
"query",
"(",
"self",
",",
"url",
",",
"method",
"=",
"'GET'",
",",
"extra_params",
"=",
"None",
",",
"extra_headers",
"=",
"None",
",",
"retry",
"=",
"3",
",",
"raw",
"=",
"False",
",",
"stream",
"=",
"False",
")",
":",
"response",
"=",
"None",
"loop",
"=",
"0",
"# always make sure the headers and params are clean",
"self",
".",
"cleanup_headers",
"(",
")",
"while",
"loop",
"<=",
"retry",
":",
"# override request.body or request.headers dictionary",
"if",
"extra_params",
":",
"params",
"=",
"self",
".",
"__params",
"params",
".",
"update",
"(",
"extra_params",
")",
"else",
":",
"params",
"=",
"self",
".",
"__params",
"_LOGGER",
".",
"debug",
"(",
"\"Params: %s\"",
",",
"params",
")",
"if",
"extra_headers",
":",
"headers",
"=",
"self",
".",
"__headers",
"headers",
".",
"update",
"(",
"extra_headers",
")",
"else",
":",
"headers",
"=",
"self",
".",
"__headers",
"_LOGGER",
".",
"debug",
"(",
"\"Headers: %s\"",
",",
"headers",
")",
"_LOGGER",
".",
"debug",
"(",
"\"Querying %s on attempt: %s/%s\"",
",",
"url",
",",
"loop",
",",
"retry",
")",
"loop",
"+=",
"1",
"# define connection method",
"req",
"=",
"None",
"if",
"method",
"==",
"'GET'",
":",
"req",
"=",
"self",
".",
"session",
".",
"get",
"(",
"url",
",",
"headers",
"=",
"headers",
",",
"stream",
"=",
"stream",
")",
"elif",
"method",
"==",
"'PUT'",
":",
"req",
"=",
"self",
".",
"session",
".",
"put",
"(",
"url",
",",
"json",
"=",
"params",
",",
"headers",
"=",
"headers",
")",
"elif",
"method",
"==",
"'POST'",
":",
"req",
"=",
"self",
".",
"session",
".",
"post",
"(",
"url",
",",
"json",
"=",
"params",
",",
"headers",
"=",
"headers",
")",
"if",
"req",
"and",
"(",
"req",
".",
"status_code",
"==",
"200",
")",
":",
"if",
"raw",
":",
"_LOGGER",
".",
"debug",
"(",
"\"Required raw object.\"",
")",
"response",
"=",
"req",
"else",
":",
"response",
"=",
"req",
".",
"json",
"(",
")",
"# leave if everything worked fine",
"break",
"return",
"response"
] |
Return a JSON object or raw session.
:param url: Arlo API URL
:param method: Specify the method GET, POST or PUT. Default is GET.
:param extra_params: Dictionary to be appended on request.body
:param extra_headers: Dictionary to be apppended on request.headers
:param retry: Attempts to retry a query. Default is 3.
:param raw: Boolean if query() will return request object instead JSON.
:param stream: Boolean if query() will return a stream object.
|
[
"Return",
"a",
"JSON",
"object",
"or",
"raw",
"session",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/__init__.py#L93-L158
|
train
|
tchellomello/python-arlo
|
pyarlo/__init__.py
|
PyArlo.devices
|
def devices(self):
"""Return all devices on Arlo account."""
if self._all_devices:
return self._all_devices
self._all_devices = {}
self._all_devices['cameras'] = []
self._all_devices['base_station'] = []
url = DEVICES_ENDPOINT
data = self.query(url)
for device in data.get('data'):
name = device.get('deviceName')
if ((device.get('deviceType') == 'camera' or
device.get('deviceType') == 'arloq' or
device.get('deviceType') == 'arloqs') and
device.get('state') == 'provisioned'):
camera = ArloCamera(name, device, self)
self._all_devices['cameras'].append(camera)
if (device.get('state') == 'provisioned' and
(device.get('deviceType') == 'basestation' or
device.get('modelId') == 'ABC1000')):
base = ArloBaseStation(name, device, self.__token, self)
self._all_devices['base_station'].append(base)
return self._all_devices
|
python
|
def devices(self):
"""Return all devices on Arlo account."""
if self._all_devices:
return self._all_devices
self._all_devices = {}
self._all_devices['cameras'] = []
self._all_devices['base_station'] = []
url = DEVICES_ENDPOINT
data = self.query(url)
for device in data.get('data'):
name = device.get('deviceName')
if ((device.get('deviceType') == 'camera' or
device.get('deviceType') == 'arloq' or
device.get('deviceType') == 'arloqs') and
device.get('state') == 'provisioned'):
camera = ArloCamera(name, device, self)
self._all_devices['cameras'].append(camera)
if (device.get('state') == 'provisioned' and
(device.get('deviceType') == 'basestation' or
device.get('modelId') == 'ABC1000')):
base = ArloBaseStation(name, device, self.__token, self)
self._all_devices['base_station'].append(base)
return self._all_devices
|
[
"def",
"devices",
"(",
"self",
")",
":",
"if",
"self",
".",
"_all_devices",
":",
"return",
"self",
".",
"_all_devices",
"self",
".",
"_all_devices",
"=",
"{",
"}",
"self",
".",
"_all_devices",
"[",
"'cameras'",
"]",
"=",
"[",
"]",
"self",
".",
"_all_devices",
"[",
"'base_station'",
"]",
"=",
"[",
"]",
"url",
"=",
"DEVICES_ENDPOINT",
"data",
"=",
"self",
".",
"query",
"(",
"url",
")",
"for",
"device",
"in",
"data",
".",
"get",
"(",
"'data'",
")",
":",
"name",
"=",
"device",
".",
"get",
"(",
"'deviceName'",
")",
"if",
"(",
"(",
"device",
".",
"get",
"(",
"'deviceType'",
")",
"==",
"'camera'",
"or",
"device",
".",
"get",
"(",
"'deviceType'",
")",
"==",
"'arloq'",
"or",
"device",
".",
"get",
"(",
"'deviceType'",
")",
"==",
"'arloqs'",
")",
"and",
"device",
".",
"get",
"(",
"'state'",
")",
"==",
"'provisioned'",
")",
":",
"camera",
"=",
"ArloCamera",
"(",
"name",
",",
"device",
",",
"self",
")",
"self",
".",
"_all_devices",
"[",
"'cameras'",
"]",
".",
"append",
"(",
"camera",
")",
"if",
"(",
"device",
".",
"get",
"(",
"'state'",
")",
"==",
"'provisioned'",
"and",
"(",
"device",
".",
"get",
"(",
"'deviceType'",
")",
"==",
"'basestation'",
"or",
"device",
".",
"get",
"(",
"'modelId'",
")",
"==",
"'ABC1000'",
")",
")",
":",
"base",
"=",
"ArloBaseStation",
"(",
"name",
",",
"device",
",",
"self",
".",
"__token",
",",
"self",
")",
"self",
".",
"_all_devices",
"[",
"'base_station'",
"]",
".",
"append",
"(",
"base",
")",
"return",
"self",
".",
"_all_devices"
] |
Return all devices on Arlo account.
|
[
"Return",
"all",
"devices",
"on",
"Arlo",
"account",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/__init__.py#L171-L198
|
train
|
tchellomello/python-arlo
|
pyarlo/__init__.py
|
PyArlo.lookup_camera_by_id
|
def lookup_camera_by_id(self, device_id):
"""Return camera object by device_id."""
camera = list(filter(
lambda cam: cam.device_id == device_id, self.cameras))[0]
if camera:
return camera
return None
|
python
|
def lookup_camera_by_id(self, device_id):
"""Return camera object by device_id."""
camera = list(filter(
lambda cam: cam.device_id == device_id, self.cameras))[0]
if camera:
return camera
return None
|
[
"def",
"lookup_camera_by_id",
"(",
"self",
",",
"device_id",
")",
":",
"camera",
"=",
"list",
"(",
"filter",
"(",
"lambda",
"cam",
":",
"cam",
".",
"device_id",
"==",
"device_id",
",",
"self",
".",
"cameras",
")",
")",
"[",
"0",
"]",
"if",
"camera",
":",
"return",
"camera",
"return",
"None"
] |
Return camera object by device_id.
|
[
"Return",
"camera",
"object",
"by",
"device_id",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/__init__.py#L200-L206
|
train
|
tchellomello/python-arlo
|
pyarlo/__init__.py
|
PyArlo.refresh_attributes
|
def refresh_attributes(self, name):
"""Refresh attributes from a given Arlo object."""
url = DEVICES_ENDPOINT
response = self.query(url)
if not response or not isinstance(response, dict):
return None
for device in response.get('data'):
if device.get('deviceName') == name:
return device
return None
|
python
|
def refresh_attributes(self, name):
"""Refresh attributes from a given Arlo object."""
url = DEVICES_ENDPOINT
response = self.query(url)
if not response or not isinstance(response, dict):
return None
for device in response.get('data'):
if device.get('deviceName') == name:
return device
return None
|
[
"def",
"refresh_attributes",
"(",
"self",
",",
"name",
")",
":",
"url",
"=",
"DEVICES_ENDPOINT",
"response",
"=",
"self",
".",
"query",
"(",
"url",
")",
"if",
"not",
"response",
"or",
"not",
"isinstance",
"(",
"response",
",",
"dict",
")",
":",
"return",
"None",
"for",
"device",
"in",
"response",
".",
"get",
"(",
"'data'",
")",
":",
"if",
"device",
".",
"get",
"(",
"'deviceName'",
")",
"==",
"name",
":",
"return",
"device",
"return",
"None"
] |
Refresh attributes from a given Arlo object.
|
[
"Refresh",
"attributes",
"from",
"a",
"given",
"Arlo",
"object",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/__init__.py#L208-L219
|
train
|
tchellomello/python-arlo
|
pyarlo/__init__.py
|
PyArlo.update
|
def update(self, update_cameras=False, update_base_station=False):
"""Refresh object."""
self._authenticate()
# update attributes in all cameras to avoid duped queries
if update_cameras:
url = DEVICES_ENDPOINT
response = self.query(url)
if not response or not isinstance(response, dict):
return
for camera in self.cameras:
for dev_info in response.get('data'):
if dev_info.get('deviceName') == camera.name:
_LOGGER.debug("Refreshing %s attributes", camera.name)
camera.attrs = dev_info
# preload cached videos
# the user is still able to force a new query by
# calling the Arlo.video()
camera.make_video_cache()
# force update base_station
if update_base_station:
for base in self.base_stations:
base.update()
|
python
|
def update(self, update_cameras=False, update_base_station=False):
"""Refresh object."""
self._authenticate()
# update attributes in all cameras to avoid duped queries
if update_cameras:
url = DEVICES_ENDPOINT
response = self.query(url)
if not response or not isinstance(response, dict):
return
for camera in self.cameras:
for dev_info in response.get('data'):
if dev_info.get('deviceName') == camera.name:
_LOGGER.debug("Refreshing %s attributes", camera.name)
camera.attrs = dev_info
# preload cached videos
# the user is still able to force a new query by
# calling the Arlo.video()
camera.make_video_cache()
# force update base_station
if update_base_station:
for base in self.base_stations:
base.update()
|
[
"def",
"update",
"(",
"self",
",",
"update_cameras",
"=",
"False",
",",
"update_base_station",
"=",
"False",
")",
":",
"self",
".",
"_authenticate",
"(",
")",
"# update attributes in all cameras to avoid duped queries",
"if",
"update_cameras",
":",
"url",
"=",
"DEVICES_ENDPOINT",
"response",
"=",
"self",
".",
"query",
"(",
"url",
")",
"if",
"not",
"response",
"or",
"not",
"isinstance",
"(",
"response",
",",
"dict",
")",
":",
"return",
"for",
"camera",
"in",
"self",
".",
"cameras",
":",
"for",
"dev_info",
"in",
"response",
".",
"get",
"(",
"'data'",
")",
":",
"if",
"dev_info",
".",
"get",
"(",
"'deviceName'",
")",
"==",
"camera",
".",
"name",
":",
"_LOGGER",
".",
"debug",
"(",
"\"Refreshing %s attributes\"",
",",
"camera",
".",
"name",
")",
"camera",
".",
"attrs",
"=",
"dev_info",
"# preload cached videos",
"# the user is still able to force a new query by",
"# calling the Arlo.video()",
"camera",
".",
"make_video_cache",
"(",
")",
"# force update base_station",
"if",
"update_base_station",
":",
"for",
"base",
"in",
"self",
".",
"base_stations",
":",
"base",
".",
"update",
"(",
")"
] |
Refresh object.
|
[
"Refresh",
"object",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/__init__.py#L249-L274
|
train
|
tchellomello/python-arlo
|
pyarlo/media.py
|
ArloMediaLibrary.load
|
def load(self, days=PRELOAD_DAYS, only_cameras=None,
date_from=None, date_to=None, limit=None):
"""Load Arlo videos from the given criteria
:param days: number of days to retrieve
:param only_cameras: retrieve only <ArloCamera> on that list
:param date_from: refine from initial date
:param date_to: refine final date
:param limit: define number of objects to return
"""
videos = []
url = LIBRARY_ENDPOINT
if not (date_from and date_to):
now = datetime.today()
date_from = (now - timedelta(days=days)).strftime('%Y%m%d')
date_to = now.strftime('%Y%m%d')
params = {'dateFrom': date_from, 'dateTo': date_to}
data = self._session.query(url,
method='POST',
extra_params=params).get('data')
# get all cameras to append to create ArloVideo object
all_cameras = self._session.cameras
for video in data:
# pylint: disable=cell-var-from-loop
srccam = \
list(filter(
lambda cam: cam.device_id == video.get('deviceId'),
all_cameras)
)[0]
# make sure only_cameras is a list
if only_cameras and \
not isinstance(only_cameras, list):
only_cameras = [(only_cameras)]
# filter by camera only
if only_cameras:
if list(filter(lambda cam: cam.device_id == srccam.device_id,
list(only_cameras))):
videos.append(ArloVideo(video, srccam, self._session))
else:
videos.append(ArloVideo(video, srccam, self._session))
if limit:
return videos[:limit]
return videos
|
python
|
def load(self, days=PRELOAD_DAYS, only_cameras=None,
date_from=None, date_to=None, limit=None):
"""Load Arlo videos from the given criteria
:param days: number of days to retrieve
:param only_cameras: retrieve only <ArloCamera> on that list
:param date_from: refine from initial date
:param date_to: refine final date
:param limit: define number of objects to return
"""
videos = []
url = LIBRARY_ENDPOINT
if not (date_from and date_to):
now = datetime.today()
date_from = (now - timedelta(days=days)).strftime('%Y%m%d')
date_to = now.strftime('%Y%m%d')
params = {'dateFrom': date_from, 'dateTo': date_to}
data = self._session.query(url,
method='POST',
extra_params=params).get('data')
# get all cameras to append to create ArloVideo object
all_cameras = self._session.cameras
for video in data:
# pylint: disable=cell-var-from-loop
srccam = \
list(filter(
lambda cam: cam.device_id == video.get('deviceId'),
all_cameras)
)[0]
# make sure only_cameras is a list
if only_cameras and \
not isinstance(only_cameras, list):
only_cameras = [(only_cameras)]
# filter by camera only
if only_cameras:
if list(filter(lambda cam: cam.device_id == srccam.device_id,
list(only_cameras))):
videos.append(ArloVideo(video, srccam, self._session))
else:
videos.append(ArloVideo(video, srccam, self._session))
if limit:
return videos[:limit]
return videos
|
[
"def",
"load",
"(",
"self",
",",
"days",
"=",
"PRELOAD_DAYS",
",",
"only_cameras",
"=",
"None",
",",
"date_from",
"=",
"None",
",",
"date_to",
"=",
"None",
",",
"limit",
"=",
"None",
")",
":",
"videos",
"=",
"[",
"]",
"url",
"=",
"LIBRARY_ENDPOINT",
"if",
"not",
"(",
"date_from",
"and",
"date_to",
")",
":",
"now",
"=",
"datetime",
".",
"today",
"(",
")",
"date_from",
"=",
"(",
"now",
"-",
"timedelta",
"(",
"days",
"=",
"days",
")",
")",
".",
"strftime",
"(",
"'%Y%m%d'",
")",
"date_to",
"=",
"now",
".",
"strftime",
"(",
"'%Y%m%d'",
")",
"params",
"=",
"{",
"'dateFrom'",
":",
"date_from",
",",
"'dateTo'",
":",
"date_to",
"}",
"data",
"=",
"self",
".",
"_session",
".",
"query",
"(",
"url",
",",
"method",
"=",
"'POST'",
",",
"extra_params",
"=",
"params",
")",
".",
"get",
"(",
"'data'",
")",
"# get all cameras to append to create ArloVideo object",
"all_cameras",
"=",
"self",
".",
"_session",
".",
"cameras",
"for",
"video",
"in",
"data",
":",
"# pylint: disable=cell-var-from-loop",
"srccam",
"=",
"list",
"(",
"filter",
"(",
"lambda",
"cam",
":",
"cam",
".",
"device_id",
"==",
"video",
".",
"get",
"(",
"'deviceId'",
")",
",",
"all_cameras",
")",
")",
"[",
"0",
"]",
"# make sure only_cameras is a list",
"if",
"only_cameras",
"and",
"not",
"isinstance",
"(",
"only_cameras",
",",
"list",
")",
":",
"only_cameras",
"=",
"[",
"(",
"only_cameras",
")",
"]",
"# filter by camera only",
"if",
"only_cameras",
":",
"if",
"list",
"(",
"filter",
"(",
"lambda",
"cam",
":",
"cam",
".",
"device_id",
"==",
"srccam",
".",
"device_id",
",",
"list",
"(",
"only_cameras",
")",
")",
")",
":",
"videos",
".",
"append",
"(",
"ArloVideo",
"(",
"video",
",",
"srccam",
",",
"self",
".",
"_session",
")",
")",
"else",
":",
"videos",
".",
"append",
"(",
"ArloVideo",
"(",
"video",
",",
"srccam",
",",
"self",
".",
"_session",
")",
")",
"if",
"limit",
":",
"return",
"videos",
"[",
":",
"limit",
"]",
"return",
"videos"
] |
Load Arlo videos from the given criteria
:param days: number of days to retrieve
:param only_cameras: retrieve only <ArloCamera> on that list
:param date_from: refine from initial date
:param date_to: refine final date
:param limit: define number of objects to return
|
[
"Load",
"Arlo",
"videos",
"from",
"the",
"given",
"criteria"
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/media.py#L38-L87
|
train
|
tchellomello/python-arlo
|
pyarlo/media.py
|
ArloVideo._name
|
def _name(self):
"""Define object name."""
return "{0} {1} {2}".format(
self._camera.name,
pretty_timestamp(self.created_at),
self._attrs.get('mediaDuration'))
|
python
|
def _name(self):
"""Define object name."""
return "{0} {1} {2}".format(
self._camera.name,
pretty_timestamp(self.created_at),
self._attrs.get('mediaDuration'))
|
[
"def",
"_name",
"(",
"self",
")",
":",
"return",
"\"{0} {1} {2}\"",
".",
"format",
"(",
"self",
".",
"_camera",
".",
"name",
",",
"pretty_timestamp",
"(",
"self",
".",
"created_at",
")",
",",
"self",
".",
"_attrs",
".",
"get",
"(",
"'mediaDuration'",
")",
")"
] |
Define object name.
|
[
"Define",
"object",
"name",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/media.py#L110-L115
|
train
|
tchellomello/python-arlo
|
pyarlo/media.py
|
ArloVideo.created_at_pretty
|
def created_at_pretty(self, date_format=None):
"""Return pretty timestamp."""
if date_format:
return pretty_timestamp(self.created_at, date_format=date_format)
return pretty_timestamp(self.created_at)
|
python
|
def created_at_pretty(self, date_format=None):
"""Return pretty timestamp."""
if date_format:
return pretty_timestamp(self.created_at, date_format=date_format)
return pretty_timestamp(self.created_at)
|
[
"def",
"created_at_pretty",
"(",
"self",
",",
"date_format",
"=",
"None",
")",
":",
"if",
"date_format",
":",
"return",
"pretty_timestamp",
"(",
"self",
".",
"created_at",
",",
"date_format",
"=",
"date_format",
")",
"return",
"pretty_timestamp",
"(",
"self",
".",
"created_at",
")"
] |
Return pretty timestamp.
|
[
"Return",
"pretty",
"timestamp",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/media.py#L132-L136
|
train
|
tchellomello/python-arlo
|
pyarlo/media.py
|
ArloVideo.created_today
|
def created_today(self):
"""Return True if created today."""
if self.datetime.date() == datetime.today().date():
return True
return False
|
python
|
def created_today(self):
"""Return True if created today."""
if self.datetime.date() == datetime.today().date():
return True
return False
|
[
"def",
"created_today",
"(",
"self",
")",
":",
"if",
"self",
".",
"datetime",
".",
"date",
"(",
")",
"==",
"datetime",
".",
"today",
"(",
")",
".",
"date",
"(",
")",
":",
"return",
"True",
"return",
"False"
] |
Return True if created today.
|
[
"Return",
"True",
"if",
"created",
"today",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/media.py#L139-L143
|
train
|
tchellomello/python-arlo
|
pyarlo/utils.py
|
to_datetime
|
def to_datetime(timestamp):
"""Return datetime object from timestamp."""
return dt.fromtimestamp(time.mktime(
time.localtime(int(str(timestamp)[:10]))))
|
python
|
def to_datetime(timestamp):
"""Return datetime object from timestamp."""
return dt.fromtimestamp(time.mktime(
time.localtime(int(str(timestamp)[:10]))))
|
[
"def",
"to_datetime",
"(",
"timestamp",
")",
":",
"return",
"dt",
".",
"fromtimestamp",
"(",
"time",
".",
"mktime",
"(",
"time",
".",
"localtime",
"(",
"int",
"(",
"str",
"(",
"timestamp",
")",
"[",
":",
"10",
"]",
")",
")",
")",
")"
] |
Return datetime object from timestamp.
|
[
"Return",
"datetime",
"object",
"from",
"timestamp",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/utils.py#L11-L14
|
train
|
tchellomello/python-arlo
|
pyarlo/utils.py
|
pretty_timestamp
|
def pretty_timestamp(timestamp, date_format='%a-%m_%d_%y:%H:%M:%S'):
"""Huminize timestamp."""
return time.strftime(date_format,
time.localtime(int(str(timestamp)[:10])))
|
python
|
def pretty_timestamp(timestamp, date_format='%a-%m_%d_%y:%H:%M:%S'):
"""Huminize timestamp."""
return time.strftime(date_format,
time.localtime(int(str(timestamp)[:10])))
|
[
"def",
"pretty_timestamp",
"(",
"timestamp",
",",
"date_format",
"=",
"'%a-%m_%d_%y:%H:%M:%S'",
")",
":",
"return",
"time",
".",
"strftime",
"(",
"date_format",
",",
"time",
".",
"localtime",
"(",
"int",
"(",
"str",
"(",
"timestamp",
")",
"[",
":",
"10",
"]",
")",
")",
")"
] |
Huminize timestamp.
|
[
"Huminize",
"timestamp",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/utils.py#L17-L20
|
train
|
tchellomello/python-arlo
|
pyarlo/utils.py
|
http_get
|
def http_get(url, filename=None):
"""Download HTTP data."""
try:
ret = requests.get(url)
except requests.exceptions.SSLError as error:
_LOGGER.error(error)
return False
if ret.status_code != 200:
return False
if filename is None:
return ret.content
with open(filename, 'wb') as data:
data.write(ret.content)
return True
|
python
|
def http_get(url, filename=None):
"""Download HTTP data."""
try:
ret = requests.get(url)
except requests.exceptions.SSLError as error:
_LOGGER.error(error)
return False
if ret.status_code != 200:
return False
if filename is None:
return ret.content
with open(filename, 'wb') as data:
data.write(ret.content)
return True
|
[
"def",
"http_get",
"(",
"url",
",",
"filename",
"=",
"None",
")",
":",
"try",
":",
"ret",
"=",
"requests",
".",
"get",
"(",
"url",
")",
"except",
"requests",
".",
"exceptions",
".",
"SSLError",
"as",
"error",
":",
"_LOGGER",
".",
"error",
"(",
"error",
")",
"return",
"False",
"if",
"ret",
".",
"status_code",
"!=",
"200",
":",
"return",
"False",
"if",
"filename",
"is",
"None",
":",
"return",
"ret",
".",
"content",
"with",
"open",
"(",
"filename",
",",
"'wb'",
")",
"as",
"data",
":",
"data",
".",
"write",
"(",
"ret",
".",
"content",
")",
"return",
"True"
] |
Download HTTP data.
|
[
"Download",
"HTTP",
"data",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/utils.py#L23-L39
|
train
|
tchellomello/python-arlo
|
pyarlo/utils.py
|
http_stream
|
def http_stream(url, chunk=4096):
"""Generate stream for a given record video.
:param chunk: chunk bytes to read per time
:returns generator object
"""
ret = requests.get(url, stream=True)
ret.raise_for_status()
for data in ret.iter_content(chunk):
yield data
|
python
|
def http_stream(url, chunk=4096):
"""Generate stream for a given record video.
:param chunk: chunk bytes to read per time
:returns generator object
"""
ret = requests.get(url, stream=True)
ret.raise_for_status()
for data in ret.iter_content(chunk):
yield data
|
[
"def",
"http_stream",
"(",
"url",
",",
"chunk",
"=",
"4096",
")",
":",
"ret",
"=",
"requests",
".",
"get",
"(",
"url",
",",
"stream",
"=",
"True",
")",
"ret",
".",
"raise_for_status",
"(",
")",
"for",
"data",
"in",
"ret",
".",
"iter_content",
"(",
"chunk",
")",
":",
"yield",
"data"
] |
Generate stream for a given record video.
:param chunk: chunk bytes to read per time
:returns generator object
|
[
"Generate",
"stream",
"for",
"a",
"given",
"record",
"video",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/utils.py#L42-L51
|
train
|
tchellomello/python-arlo
|
pyarlo/camera.py
|
ArloCamera.unseen_videos_reset
|
def unseen_videos_reset(self):
"""Reset the unseen videos counter."""
url = RESET_CAM_ENDPOINT.format(self.unique_id)
ret = self._session.query(url).get('success')
return ret
|
python
|
def unseen_videos_reset(self):
"""Reset the unseen videos counter."""
url = RESET_CAM_ENDPOINT.format(self.unique_id)
ret = self._session.query(url).get('success')
return ret
|
[
"def",
"unseen_videos_reset",
"(",
"self",
")",
":",
"url",
"=",
"RESET_CAM_ENDPOINT",
".",
"format",
"(",
"self",
".",
"unique_id",
")",
"ret",
"=",
"self",
".",
"_session",
".",
"query",
"(",
"url",
")",
".",
"get",
"(",
"'success'",
")",
"return",
"ret"
] |
Reset the unseen videos counter.
|
[
"Reset",
"the",
"unseen",
"videos",
"counter",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/camera.py#L128-L132
|
train
|
tchellomello/python-arlo
|
pyarlo/camera.py
|
ArloCamera.make_video_cache
|
def make_video_cache(self, days=None):
"""Save videos on _cache_videos to avoid dups."""
if days is None:
days = self._min_days_vdo_cache
self._cached_videos = self.videos(days)
|
python
|
def make_video_cache(self, days=None):
"""Save videos on _cache_videos to avoid dups."""
if days is None:
days = self._min_days_vdo_cache
self._cached_videos = self.videos(days)
|
[
"def",
"make_video_cache",
"(",
"self",
",",
"days",
"=",
"None",
")",
":",
"if",
"days",
"is",
"None",
":",
"days",
"=",
"self",
".",
"_min_days_vdo_cache",
"self",
".",
"_cached_videos",
"=",
"self",
".",
"videos",
"(",
"days",
")"
] |
Save videos on _cache_videos to avoid dups.
|
[
"Save",
"videos",
"on",
"_cache_videos",
"to",
"avoid",
"dups",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/camera.py#L171-L175
|
train
|
tchellomello/python-arlo
|
pyarlo/camera.py
|
ArloCamera.base_station
|
def base_station(self):
"""Return the base_station assigned for the given camera."""
try:
return list(filter(lambda x: x.device_id == self.parent_id,
self._session.base_stations))[0]
except (IndexError, AttributeError):
return None
|
python
|
def base_station(self):
"""Return the base_station assigned for the given camera."""
try:
return list(filter(lambda x: x.device_id == self.parent_id,
self._session.base_stations))[0]
except (IndexError, AttributeError):
return None
|
[
"def",
"base_station",
"(",
"self",
")",
":",
"try",
":",
"return",
"list",
"(",
"filter",
"(",
"lambda",
"x",
":",
"x",
".",
"device_id",
"==",
"self",
".",
"parent_id",
",",
"self",
".",
"_session",
".",
"base_stations",
")",
")",
"[",
"0",
"]",
"except",
"(",
"IndexError",
",",
"AttributeError",
")",
":",
"return",
"None"
] |
Return the base_station assigned for the given camera.
|
[
"Return",
"the",
"base_station",
"assigned",
"for",
"the",
"given",
"camera",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/camera.py#L216-L222
|
train
|
tchellomello/python-arlo
|
pyarlo/camera.py
|
ArloCamera._get_camera_properties
|
def _get_camera_properties(self):
"""Lookup camera properties from base station."""
if self.base_station and self.base_station.camera_properties:
for cam in self.base_station.camera_properties:
if cam["serialNumber"] == self.device_id:
return cam
return None
|
python
|
def _get_camera_properties(self):
"""Lookup camera properties from base station."""
if self.base_station and self.base_station.camera_properties:
for cam in self.base_station.camera_properties:
if cam["serialNumber"] == self.device_id:
return cam
return None
|
[
"def",
"_get_camera_properties",
"(",
"self",
")",
":",
"if",
"self",
".",
"base_station",
"and",
"self",
".",
"base_station",
".",
"camera_properties",
":",
"for",
"cam",
"in",
"self",
".",
"base_station",
".",
"camera_properties",
":",
"if",
"cam",
"[",
"\"serialNumber\"",
"]",
"==",
"self",
".",
"device_id",
":",
"return",
"cam",
"return",
"None"
] |
Lookup camera properties from base station.
|
[
"Lookup",
"camera",
"properties",
"from",
"base",
"station",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/camera.py#L224-L230
|
train
|
tchellomello/python-arlo
|
pyarlo/camera.py
|
ArloCamera.triggers
|
def triggers(self):
"""Get a camera's triggers."""
capabilities = self.capabilities
if not capabilities:
return None
for capability in capabilities:
if not isinstance(capability, dict):
continue
triggers = capability.get("Triggers")
if triggers:
return triggers
return None
|
python
|
def triggers(self):
"""Get a camera's triggers."""
capabilities = self.capabilities
if not capabilities:
return None
for capability in capabilities:
if not isinstance(capability, dict):
continue
triggers = capability.get("Triggers")
if triggers:
return triggers
return None
|
[
"def",
"triggers",
"(",
"self",
")",
":",
"capabilities",
"=",
"self",
".",
"capabilities",
"if",
"not",
"capabilities",
":",
"return",
"None",
"for",
"capability",
"in",
"capabilities",
":",
"if",
"not",
"isinstance",
"(",
"capability",
",",
"dict",
")",
":",
"continue",
"triggers",
"=",
"capability",
".",
"get",
"(",
"\"Triggers\"",
")",
"if",
"triggers",
":",
"return",
"triggers",
"return",
"None"
] |
Get a camera's triggers.
|
[
"Get",
"a",
"camera",
"s",
"triggers",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/camera.py#L244-L258
|
train
|
tchellomello/python-arlo
|
pyarlo/camera.py
|
ArloCamera.motion_detection_sensitivity
|
def motion_detection_sensitivity(self):
"""Sensitivity level of Camera motion detection."""
if not self.triggers:
return None
for trigger in self.triggers:
if trigger.get("type") != "pirMotionActive":
continue
sensitivity = trigger.get("sensitivity")
if sensitivity:
return sensitivity.get("default")
return None
|
python
|
def motion_detection_sensitivity(self):
"""Sensitivity level of Camera motion detection."""
if not self.triggers:
return None
for trigger in self.triggers:
if trigger.get("type") != "pirMotionActive":
continue
sensitivity = trigger.get("sensitivity")
if sensitivity:
return sensitivity.get("default")
return None
|
[
"def",
"motion_detection_sensitivity",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"triggers",
":",
"return",
"None",
"for",
"trigger",
"in",
"self",
".",
"triggers",
":",
"if",
"trigger",
".",
"get",
"(",
"\"type\"",
")",
"!=",
"\"pirMotionActive\"",
":",
"continue",
"sensitivity",
"=",
"trigger",
".",
"get",
"(",
"\"sensitivity\"",
")",
"if",
"sensitivity",
":",
"return",
"sensitivity",
".",
"get",
"(",
"\"default\"",
")",
"return",
"None"
] |
Sensitivity level of Camera motion detection.
|
[
"Sensitivity",
"level",
"of",
"Camera",
"motion",
"detection",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/camera.py#L304-L317
|
train
|
tchellomello/python-arlo
|
pyarlo/camera.py
|
ArloCamera.audio_detection_sensitivity
|
def audio_detection_sensitivity(self):
"""Sensitivity level of Camera audio detection."""
if not self.triggers:
return None
for trigger in self.triggers:
if trigger.get("type") != "audioAmplitude":
continue
sensitivity = trigger.get("sensitivity")
if sensitivity:
return sensitivity.get("default")
return None
|
python
|
def audio_detection_sensitivity(self):
"""Sensitivity level of Camera audio detection."""
if not self.triggers:
return None
for trigger in self.triggers:
if trigger.get("type") != "audioAmplitude":
continue
sensitivity = trigger.get("sensitivity")
if sensitivity:
return sensitivity.get("default")
return None
|
[
"def",
"audio_detection_sensitivity",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"triggers",
":",
"return",
"None",
"for",
"trigger",
"in",
"self",
".",
"triggers",
":",
"if",
"trigger",
".",
"get",
"(",
"\"type\"",
")",
"!=",
"\"audioAmplitude\"",
":",
"continue",
"sensitivity",
"=",
"trigger",
".",
"get",
"(",
"\"sensitivity\"",
")",
"if",
"sensitivity",
":",
"return",
"sensitivity",
".",
"get",
"(",
"\"default\"",
")",
"return",
"None"
] |
Sensitivity level of Camera audio detection.
|
[
"Sensitivity",
"level",
"of",
"Camera",
"audio",
"detection",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/camera.py#L320-L333
|
train
|
tchellomello/python-arlo
|
pyarlo/camera.py
|
ArloCamera.live_streaming
|
def live_streaming(self):
"""Return live streaming generator."""
url = STREAM_ENDPOINT
# override params
params = STREAMING_BODY
params['from'] = "{0}_web".format(self.user_id)
params['to'] = self.device_id
params['resource'] = "cameras/{0}".format(self.device_id)
params['transId'] = "web!{0}".format(self.xcloud_id)
# override headers
headers = {'xCloudId': self.xcloud_id}
_LOGGER.debug("Streaming device %s", self.name)
_LOGGER.debug("Device params %s", params)
_LOGGER.debug("Device headers %s", headers)
ret = self._session.query(url,
method='POST',
extra_params=params,
extra_headers=headers)
_LOGGER.debug("Streaming results %s", ret)
if ret.get('success'):
return ret.get('data').get('url')
return ret.get('data')
|
python
|
def live_streaming(self):
"""Return live streaming generator."""
url = STREAM_ENDPOINT
# override params
params = STREAMING_BODY
params['from'] = "{0}_web".format(self.user_id)
params['to'] = self.device_id
params['resource'] = "cameras/{0}".format(self.device_id)
params['transId'] = "web!{0}".format(self.xcloud_id)
# override headers
headers = {'xCloudId': self.xcloud_id}
_LOGGER.debug("Streaming device %s", self.name)
_LOGGER.debug("Device params %s", params)
_LOGGER.debug("Device headers %s", headers)
ret = self._session.query(url,
method='POST',
extra_params=params,
extra_headers=headers)
_LOGGER.debug("Streaming results %s", ret)
if ret.get('success'):
return ret.get('data').get('url')
return ret.get('data')
|
[
"def",
"live_streaming",
"(",
"self",
")",
":",
"url",
"=",
"STREAM_ENDPOINT",
"# override params",
"params",
"=",
"STREAMING_BODY",
"params",
"[",
"'from'",
"]",
"=",
"\"{0}_web\"",
".",
"format",
"(",
"self",
".",
"user_id",
")",
"params",
"[",
"'to'",
"]",
"=",
"self",
".",
"device_id",
"params",
"[",
"'resource'",
"]",
"=",
"\"cameras/{0}\"",
".",
"format",
"(",
"self",
".",
"device_id",
")",
"params",
"[",
"'transId'",
"]",
"=",
"\"web!{0}\"",
".",
"format",
"(",
"self",
".",
"xcloud_id",
")",
"# override headers",
"headers",
"=",
"{",
"'xCloudId'",
":",
"self",
".",
"xcloud_id",
"}",
"_LOGGER",
".",
"debug",
"(",
"\"Streaming device %s\"",
",",
"self",
".",
"name",
")",
"_LOGGER",
".",
"debug",
"(",
"\"Device params %s\"",
",",
"params",
")",
"_LOGGER",
".",
"debug",
"(",
"\"Device headers %s\"",
",",
"headers",
")",
"ret",
"=",
"self",
".",
"_session",
".",
"query",
"(",
"url",
",",
"method",
"=",
"'POST'",
",",
"extra_params",
"=",
"params",
",",
"extra_headers",
"=",
"headers",
")",
"_LOGGER",
".",
"debug",
"(",
"\"Streaming results %s\"",
",",
"ret",
")",
"if",
"ret",
".",
"get",
"(",
"'success'",
")",
":",
"return",
"ret",
".",
"get",
"(",
"'data'",
")",
".",
"get",
"(",
"'url'",
")",
"return",
"ret",
".",
"get",
"(",
"'data'",
")"
] |
Return live streaming generator.
|
[
"Return",
"live",
"streaming",
"generator",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/camera.py#L335-L361
|
train
|
tchellomello/python-arlo
|
pyarlo/camera.py
|
ArloCamera.schedule_snapshot
|
def schedule_snapshot(self):
"""Trigger snapshot to be uploaded to AWS.
Return success state."""
# Notes:
# - Snapshots are not immediate.
# - Snapshots will be cached for predefined amount
# of time.
# - Snapshots are not balanced. To get a better
# image, it must be taken from the stream, a few
# seconds after stream start.
url = SNAPSHOTS_ENDPOINT
params = SNAPSHOTS_BODY
params['from'] = "{0}_web".format(self.user_id)
params['to'] = self.device_id
params['resource'] = "cameras/{0}".format(self.device_id)
params['transId'] = "web!{0}".format(self.xcloud_id)
# override headers
headers = {'xCloudId': self.xcloud_id}
_LOGGER.debug("Snapshot device %s", self.name)
_LOGGER.debug("Device params %s", params)
_LOGGER.debug("Device headers %s", headers)
ret = self._session.query(url,
method='POST',
extra_params=params,
extra_headers=headers)
_LOGGER.debug("Snapshot results %s", ret)
return ret is not None and ret.get('success')
|
python
|
def schedule_snapshot(self):
"""Trigger snapshot to be uploaded to AWS.
Return success state."""
# Notes:
# - Snapshots are not immediate.
# - Snapshots will be cached for predefined amount
# of time.
# - Snapshots are not balanced. To get a better
# image, it must be taken from the stream, a few
# seconds after stream start.
url = SNAPSHOTS_ENDPOINT
params = SNAPSHOTS_BODY
params['from'] = "{0}_web".format(self.user_id)
params['to'] = self.device_id
params['resource'] = "cameras/{0}".format(self.device_id)
params['transId'] = "web!{0}".format(self.xcloud_id)
# override headers
headers = {'xCloudId': self.xcloud_id}
_LOGGER.debug("Snapshot device %s", self.name)
_LOGGER.debug("Device params %s", params)
_LOGGER.debug("Device headers %s", headers)
ret = self._session.query(url,
method='POST',
extra_params=params,
extra_headers=headers)
_LOGGER.debug("Snapshot results %s", ret)
return ret is not None and ret.get('success')
|
[
"def",
"schedule_snapshot",
"(",
"self",
")",
":",
"# Notes:",
"# - Snapshots are not immediate.",
"# - Snapshots will be cached for predefined amount",
"# of time.",
"# - Snapshots are not balanced. To get a better",
"# image, it must be taken from the stream, a few",
"# seconds after stream start.",
"url",
"=",
"SNAPSHOTS_ENDPOINT",
"params",
"=",
"SNAPSHOTS_BODY",
"params",
"[",
"'from'",
"]",
"=",
"\"{0}_web\"",
".",
"format",
"(",
"self",
".",
"user_id",
")",
"params",
"[",
"'to'",
"]",
"=",
"self",
".",
"device_id",
"params",
"[",
"'resource'",
"]",
"=",
"\"cameras/{0}\"",
".",
"format",
"(",
"self",
".",
"device_id",
")",
"params",
"[",
"'transId'",
"]",
"=",
"\"web!{0}\"",
".",
"format",
"(",
"self",
".",
"xcloud_id",
")",
"# override headers",
"headers",
"=",
"{",
"'xCloudId'",
":",
"self",
".",
"xcloud_id",
"}",
"_LOGGER",
".",
"debug",
"(",
"\"Snapshot device %s\"",
",",
"self",
".",
"name",
")",
"_LOGGER",
".",
"debug",
"(",
"\"Device params %s\"",
",",
"params",
")",
"_LOGGER",
".",
"debug",
"(",
"\"Device headers %s\"",
",",
"headers",
")",
"ret",
"=",
"self",
".",
"_session",
".",
"query",
"(",
"url",
",",
"method",
"=",
"'POST'",
",",
"extra_params",
"=",
"params",
",",
"extra_headers",
"=",
"headers",
")",
"_LOGGER",
".",
"debug",
"(",
"\"Snapshot results %s\"",
",",
"ret",
")",
"return",
"ret",
"is",
"not",
"None",
"and",
"ret",
".",
"get",
"(",
"'success'",
")"
] |
Trigger snapshot to be uploaded to AWS.
Return success state.
|
[
"Trigger",
"snapshot",
"to",
"be",
"uploaded",
"to",
"AWS",
".",
"Return",
"success",
"state",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/camera.py#L374-L405
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.thread_function
|
def thread_function(self):
"""Thread function."""
self.__subscribed = True
url = SUBSCRIBE_ENDPOINT + "?token=" + self._session_token
data = self._session.query(url, method='GET', raw=True, stream=True)
if not data or not data.ok:
_LOGGER.debug("Did not receive a valid response. Aborting..")
return None
self.__sseclient = sseclient.SSEClient(data)
try:
for event in (self.__sseclient).events():
if not self.__subscribed:
break
data = json.loads(event.data)
if data.get('status') == "connected":
_LOGGER.debug("Successfully subscribed this base station")
elif data.get('action'):
action = data.get('action')
resource = data.get('resource')
if action == "logout":
_LOGGER.debug("Logged out by some other entity")
self.__subscribed = False
break
elif action == "is" and "subscriptions/" not in resource:
self.__events.append(data)
self.__event_handle.set()
except TypeError as error:
_LOGGER.debug("Got unexpected error: %s", error)
return None
return True
|
python
|
def thread_function(self):
"""Thread function."""
self.__subscribed = True
url = SUBSCRIBE_ENDPOINT + "?token=" + self._session_token
data = self._session.query(url, method='GET', raw=True, stream=True)
if not data or not data.ok:
_LOGGER.debug("Did not receive a valid response. Aborting..")
return None
self.__sseclient = sseclient.SSEClient(data)
try:
for event in (self.__sseclient).events():
if not self.__subscribed:
break
data = json.loads(event.data)
if data.get('status') == "connected":
_LOGGER.debug("Successfully subscribed this base station")
elif data.get('action'):
action = data.get('action')
resource = data.get('resource')
if action == "logout":
_LOGGER.debug("Logged out by some other entity")
self.__subscribed = False
break
elif action == "is" and "subscriptions/" not in resource:
self.__events.append(data)
self.__event_handle.set()
except TypeError as error:
_LOGGER.debug("Got unexpected error: %s", error)
return None
return True
|
[
"def",
"thread_function",
"(",
"self",
")",
":",
"self",
".",
"__subscribed",
"=",
"True",
"url",
"=",
"SUBSCRIBE_ENDPOINT",
"+",
"\"?token=\"",
"+",
"self",
".",
"_session_token",
"data",
"=",
"self",
".",
"_session",
".",
"query",
"(",
"url",
",",
"method",
"=",
"'GET'",
",",
"raw",
"=",
"True",
",",
"stream",
"=",
"True",
")",
"if",
"not",
"data",
"or",
"not",
"data",
".",
"ok",
":",
"_LOGGER",
".",
"debug",
"(",
"\"Did not receive a valid response. Aborting..\"",
")",
"return",
"None",
"self",
".",
"__sseclient",
"=",
"sseclient",
".",
"SSEClient",
"(",
"data",
")",
"try",
":",
"for",
"event",
"in",
"(",
"self",
".",
"__sseclient",
")",
".",
"events",
"(",
")",
":",
"if",
"not",
"self",
".",
"__subscribed",
":",
"break",
"data",
"=",
"json",
".",
"loads",
"(",
"event",
".",
"data",
")",
"if",
"data",
".",
"get",
"(",
"'status'",
")",
"==",
"\"connected\"",
":",
"_LOGGER",
".",
"debug",
"(",
"\"Successfully subscribed this base station\"",
")",
"elif",
"data",
".",
"get",
"(",
"'action'",
")",
":",
"action",
"=",
"data",
".",
"get",
"(",
"'action'",
")",
"resource",
"=",
"data",
".",
"get",
"(",
"'resource'",
")",
"if",
"action",
"==",
"\"logout\"",
":",
"_LOGGER",
".",
"debug",
"(",
"\"Logged out by some other entity\"",
")",
"self",
".",
"__subscribed",
"=",
"False",
"break",
"elif",
"action",
"==",
"\"is\"",
"and",
"\"subscriptions/\"",
"not",
"in",
"resource",
":",
"self",
".",
"__events",
".",
"append",
"(",
"data",
")",
"self",
".",
"__event_handle",
".",
"set",
"(",
")",
"except",
"TypeError",
"as",
"error",
":",
"_LOGGER",
".",
"debug",
"(",
"\"Got unexpected error: %s\"",
",",
"error",
")",
"return",
"None",
"return",
"True"
] |
Thread function.
|
[
"Thread",
"function",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L55-L90
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation._get_event_stream
|
def _get_event_stream(self):
"""Spawn a thread and monitor the Arlo Event Stream."""
self.__event_handle = threading.Event()
event_thread = threading.Thread(target=self.thread_function)
event_thread.start()
|
python
|
def _get_event_stream(self):
"""Spawn a thread and monitor the Arlo Event Stream."""
self.__event_handle = threading.Event()
event_thread = threading.Thread(target=self.thread_function)
event_thread.start()
|
[
"def",
"_get_event_stream",
"(",
"self",
")",
":",
"self",
".",
"__event_handle",
"=",
"threading",
".",
"Event",
"(",
")",
"event_thread",
"=",
"threading",
".",
"Thread",
"(",
"target",
"=",
"self",
".",
"thread_function",
")",
"event_thread",
".",
"start",
"(",
")"
] |
Spawn a thread and monitor the Arlo Event Stream.
|
[
"Spawn",
"a",
"thread",
"and",
"monitor",
"the",
"Arlo",
"Event",
"Stream",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L92-L96
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation._unsubscribe_myself
|
def _unsubscribe_myself(self):
"""Unsubscribe this base station for all events."""
url = UNSUBSCRIBE_ENDPOINT
return self._session.query(url, method='GET', raw=True, stream=False)
|
python
|
def _unsubscribe_myself(self):
"""Unsubscribe this base station for all events."""
url = UNSUBSCRIBE_ENDPOINT
return self._session.query(url, method='GET', raw=True, stream=False)
|
[
"def",
"_unsubscribe_myself",
"(",
"self",
")",
":",
"url",
"=",
"UNSUBSCRIBE_ENDPOINT",
"return",
"self",
".",
"_session",
".",
"query",
"(",
"url",
",",
"method",
"=",
"'GET'",
",",
"raw",
"=",
"True",
",",
"stream",
"=",
"False",
")"
] |
Unsubscribe this base station for all events.
|
[
"Unsubscribe",
"this",
"base",
"station",
"for",
"all",
"events",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L106-L109
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation._close_event_stream
|
def _close_event_stream(self):
"""Stop the Event stream thread."""
self.__subscribed = False
del self.__events[:]
self.__event_handle.clear()
|
python
|
def _close_event_stream(self):
"""Stop the Event stream thread."""
self.__subscribed = False
del self.__events[:]
self.__event_handle.clear()
|
[
"def",
"_close_event_stream",
"(",
"self",
")",
":",
"self",
".",
"__subscribed",
"=",
"False",
"del",
"self",
".",
"__events",
"[",
":",
"]",
"self",
".",
"__event_handle",
".",
"clear",
"(",
")"
] |
Stop the Event stream thread.
|
[
"Stop",
"the",
"Event",
"stream",
"thread",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L111-L115
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.publish_and_get_event
|
def publish_and_get_event(self, resource):
"""Publish and get the event from base station."""
l_subscribed = False
this_event = None
if not self.__subscribed:
self._get_event_stream()
self._subscribe_myself()
l_subscribed = True
status = self.publish(
action='get',
resource=resource,
mode=None,
publish_response=False)
if status == 'success':
i = 0
while not this_event and i < 2:
self.__event_handle.wait(5.0)
self.__event_handle.clear()
_LOGGER.debug("Instance %s resource: %s", str(i), resource)
for event in self.__events:
if event['resource'] == resource:
this_event = event
self.__events.remove(event)
break
i = i + 1
if l_subscribed:
self._unsubscribe_myself()
self._close_event_stream()
l_subscribed = False
return this_event
|
python
|
def publish_and_get_event(self, resource):
"""Publish and get the event from base station."""
l_subscribed = False
this_event = None
if not self.__subscribed:
self._get_event_stream()
self._subscribe_myself()
l_subscribed = True
status = self.publish(
action='get',
resource=resource,
mode=None,
publish_response=False)
if status == 'success':
i = 0
while not this_event and i < 2:
self.__event_handle.wait(5.0)
self.__event_handle.clear()
_LOGGER.debug("Instance %s resource: %s", str(i), resource)
for event in self.__events:
if event['resource'] == resource:
this_event = event
self.__events.remove(event)
break
i = i + 1
if l_subscribed:
self._unsubscribe_myself()
self._close_event_stream()
l_subscribed = False
return this_event
|
[
"def",
"publish_and_get_event",
"(",
"self",
",",
"resource",
")",
":",
"l_subscribed",
"=",
"False",
"this_event",
"=",
"None",
"if",
"not",
"self",
".",
"__subscribed",
":",
"self",
".",
"_get_event_stream",
"(",
")",
"self",
".",
"_subscribe_myself",
"(",
")",
"l_subscribed",
"=",
"True",
"status",
"=",
"self",
".",
"publish",
"(",
"action",
"=",
"'get'",
",",
"resource",
"=",
"resource",
",",
"mode",
"=",
"None",
",",
"publish_response",
"=",
"False",
")",
"if",
"status",
"==",
"'success'",
":",
"i",
"=",
"0",
"while",
"not",
"this_event",
"and",
"i",
"<",
"2",
":",
"self",
".",
"__event_handle",
".",
"wait",
"(",
"5.0",
")",
"self",
".",
"__event_handle",
".",
"clear",
"(",
")",
"_LOGGER",
".",
"debug",
"(",
"\"Instance %s resource: %s\"",
",",
"str",
"(",
"i",
")",
",",
"resource",
")",
"for",
"event",
"in",
"self",
".",
"__events",
":",
"if",
"event",
"[",
"'resource'",
"]",
"==",
"resource",
":",
"this_event",
"=",
"event",
"self",
".",
"__events",
".",
"remove",
"(",
"event",
")",
"break",
"i",
"=",
"i",
"+",
"1",
"if",
"l_subscribed",
":",
"self",
".",
"_unsubscribe_myself",
"(",
")",
"self",
".",
"_close_event_stream",
"(",
")",
"l_subscribed",
"=",
"False",
"return",
"this_event"
] |
Publish and get the event from base station.
|
[
"Publish",
"and",
"get",
"the",
"event",
"from",
"base",
"station",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L117-L151
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.publish
|
def publish(
self,
action='get',
resource=None,
camera_id=None,
mode=None,
publish_response=None,
properties=None):
"""Run action.
:param method: Specify the method GET, POST or PUT. Default is GET.
:param resource: Specify one of the resources to fetch from arlo.
:param camera_id: Specify the camera ID involved with this action
:param mode: Specify the mode to set, else None for GET operations
:param publish_response: Set to True for SETs. Default False
"""
url = NOTIFY_ENDPOINT.format(self.device_id)
body = ACTION_BODY.copy()
if properties is None:
properties = {}
if resource:
body['resource'] = resource
if action == 'get':
body['properties'] = None
else:
# consider moving this logic up a layer
if resource == 'schedule':
properties.update({'active': True})
elif resource == 'subscribe':
body['resource'] = "subscriptions/" + \
"{0}_web".format(self.user_id)
dev = []
dev.append(self.device_id)
properties.update({'devices': dev})
elif resource == 'modes':
available_modes = self.available_modes_with_ids
properties.update({'active': available_modes.get(mode)})
elif resource == 'privacy':
properties.update({'privacyActive': not mode})
body['resource'] = "cameras/{0}".format(camera_id)
body['action'] = action
body['properties'] = properties
body['publishResponse'] = publish_response
body['from'] = "{0}_web".format(self.user_id)
body['to'] = self.device_id
body['transId'] = "web!{0}".format(self.xcloud_id)
_LOGGER.debug("Action body: %s", body)
ret = \
self._session.query(url, method='POST', extra_params=body,
extra_headers={"xCloudId": self.xcloud_id})
if ret and ret.get('success'):
return 'success'
return None
|
python
|
def publish(
self,
action='get',
resource=None,
camera_id=None,
mode=None,
publish_response=None,
properties=None):
"""Run action.
:param method: Specify the method GET, POST or PUT. Default is GET.
:param resource: Specify one of the resources to fetch from arlo.
:param camera_id: Specify the camera ID involved with this action
:param mode: Specify the mode to set, else None for GET operations
:param publish_response: Set to True for SETs. Default False
"""
url = NOTIFY_ENDPOINT.format(self.device_id)
body = ACTION_BODY.copy()
if properties is None:
properties = {}
if resource:
body['resource'] = resource
if action == 'get':
body['properties'] = None
else:
# consider moving this logic up a layer
if resource == 'schedule':
properties.update({'active': True})
elif resource == 'subscribe':
body['resource'] = "subscriptions/" + \
"{0}_web".format(self.user_id)
dev = []
dev.append(self.device_id)
properties.update({'devices': dev})
elif resource == 'modes':
available_modes = self.available_modes_with_ids
properties.update({'active': available_modes.get(mode)})
elif resource == 'privacy':
properties.update({'privacyActive': not mode})
body['resource'] = "cameras/{0}".format(camera_id)
body['action'] = action
body['properties'] = properties
body['publishResponse'] = publish_response
body['from'] = "{0}_web".format(self.user_id)
body['to'] = self.device_id
body['transId'] = "web!{0}".format(self.xcloud_id)
_LOGGER.debug("Action body: %s", body)
ret = \
self._session.query(url, method='POST', extra_params=body,
extra_headers={"xCloudId": self.xcloud_id})
if ret and ret.get('success'):
return 'success'
return None
|
[
"def",
"publish",
"(",
"self",
",",
"action",
"=",
"'get'",
",",
"resource",
"=",
"None",
",",
"camera_id",
"=",
"None",
",",
"mode",
"=",
"None",
",",
"publish_response",
"=",
"None",
",",
"properties",
"=",
"None",
")",
":",
"url",
"=",
"NOTIFY_ENDPOINT",
".",
"format",
"(",
"self",
".",
"device_id",
")",
"body",
"=",
"ACTION_BODY",
".",
"copy",
"(",
")",
"if",
"properties",
"is",
"None",
":",
"properties",
"=",
"{",
"}",
"if",
"resource",
":",
"body",
"[",
"'resource'",
"]",
"=",
"resource",
"if",
"action",
"==",
"'get'",
":",
"body",
"[",
"'properties'",
"]",
"=",
"None",
"else",
":",
"# consider moving this logic up a layer",
"if",
"resource",
"==",
"'schedule'",
":",
"properties",
".",
"update",
"(",
"{",
"'active'",
":",
"True",
"}",
")",
"elif",
"resource",
"==",
"'subscribe'",
":",
"body",
"[",
"'resource'",
"]",
"=",
"\"subscriptions/\"",
"+",
"\"{0}_web\"",
".",
"format",
"(",
"self",
".",
"user_id",
")",
"dev",
"=",
"[",
"]",
"dev",
".",
"append",
"(",
"self",
".",
"device_id",
")",
"properties",
".",
"update",
"(",
"{",
"'devices'",
":",
"dev",
"}",
")",
"elif",
"resource",
"==",
"'modes'",
":",
"available_modes",
"=",
"self",
".",
"available_modes_with_ids",
"properties",
".",
"update",
"(",
"{",
"'active'",
":",
"available_modes",
".",
"get",
"(",
"mode",
")",
"}",
")",
"elif",
"resource",
"==",
"'privacy'",
":",
"properties",
".",
"update",
"(",
"{",
"'privacyActive'",
":",
"not",
"mode",
"}",
")",
"body",
"[",
"'resource'",
"]",
"=",
"\"cameras/{0}\"",
".",
"format",
"(",
"camera_id",
")",
"body",
"[",
"'action'",
"]",
"=",
"action",
"body",
"[",
"'properties'",
"]",
"=",
"properties",
"body",
"[",
"'publishResponse'",
"]",
"=",
"publish_response",
"body",
"[",
"'from'",
"]",
"=",
"\"{0}_web\"",
".",
"format",
"(",
"self",
".",
"user_id",
")",
"body",
"[",
"'to'",
"]",
"=",
"self",
".",
"device_id",
"body",
"[",
"'transId'",
"]",
"=",
"\"web!{0}\"",
".",
"format",
"(",
"self",
".",
"xcloud_id",
")",
"_LOGGER",
".",
"debug",
"(",
"\"Action body: %s\"",
",",
"body",
")",
"ret",
"=",
"self",
".",
"_session",
".",
"query",
"(",
"url",
",",
"method",
"=",
"'POST'",
",",
"extra_params",
"=",
"body",
",",
"extra_headers",
"=",
"{",
"\"xCloudId\"",
":",
"self",
".",
"xcloud_id",
"}",
")",
"if",
"ret",
"and",
"ret",
".",
"get",
"(",
"'success'",
")",
":",
"return",
"'success'",
"return",
"None"
] |
Run action.
:param method: Specify the method GET, POST or PUT. Default is GET.
:param resource: Specify one of the resources to fetch from arlo.
:param camera_id: Specify the camera ID involved with this action
:param mode: Specify the mode to set, else None for GET operations
:param publish_response: Set to True for SETs. Default False
|
[
"Run",
"action",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L153-L215
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.refresh_rate
|
def refresh_rate(self, value):
"""Override the refresh_rate attribute."""
if isinstance(value, (int, float)):
self._refresh_rate = value
|
python
|
def refresh_rate(self, value):
"""Override the refresh_rate attribute."""
if isinstance(value, (int, float)):
self._refresh_rate = value
|
[
"def",
"refresh_rate",
"(",
"self",
",",
"value",
")",
":",
"if",
"isinstance",
"(",
"value",
",",
"(",
"int",
",",
"float",
")",
")",
":",
"self",
".",
"_refresh_rate",
"=",
"value"
] |
Override the refresh_rate attribute.
|
[
"Override",
"the",
"refresh_rate",
"attribute",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L299-L302
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.available_modes
|
def available_modes(self):
"""Return list of available mode names."""
if not self._available_modes:
modes = self.available_modes_with_ids
if not modes:
return None
self._available_modes = list(modes.keys())
return self._available_modes
|
python
|
def available_modes(self):
"""Return list of available mode names."""
if not self._available_modes:
modes = self.available_modes_with_ids
if not modes:
return None
self._available_modes = list(modes.keys())
return self._available_modes
|
[
"def",
"available_modes",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"_available_modes",
":",
"modes",
"=",
"self",
".",
"available_modes_with_ids",
"if",
"not",
"modes",
":",
"return",
"None",
"self",
".",
"_available_modes",
"=",
"list",
"(",
"modes",
".",
"keys",
"(",
")",
")",
"return",
"self",
".",
"_available_modes"
] |
Return list of available mode names.
|
[
"Return",
"list",
"of",
"available",
"mode",
"names",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L305-L312
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.available_modes_with_ids
|
def available_modes_with_ids(self):
"""Return list of objects containing available mode name and id."""
if not self._available_mode_ids:
all_modes = FIXED_MODES.copy()
self._available_mode_ids = all_modes
modes = self.get_available_modes()
try:
if modes:
# pylint: disable=consider-using-dict-comprehension
simple_modes = dict(
[(m.get("type", m.get("name")), m.get("id"))
for m in modes]
)
all_modes.update(simple_modes)
self._available_mode_ids = all_modes
except TypeError:
_LOGGER.debug("Did not receive a valid response. Passing..")
return self._available_mode_ids
|
python
|
def available_modes_with_ids(self):
"""Return list of objects containing available mode name and id."""
if not self._available_mode_ids:
all_modes = FIXED_MODES.copy()
self._available_mode_ids = all_modes
modes = self.get_available_modes()
try:
if modes:
# pylint: disable=consider-using-dict-comprehension
simple_modes = dict(
[(m.get("type", m.get("name")), m.get("id"))
for m in modes]
)
all_modes.update(simple_modes)
self._available_mode_ids = all_modes
except TypeError:
_LOGGER.debug("Did not receive a valid response. Passing..")
return self._available_mode_ids
|
[
"def",
"available_modes_with_ids",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"_available_mode_ids",
":",
"all_modes",
"=",
"FIXED_MODES",
".",
"copy",
"(",
")",
"self",
".",
"_available_mode_ids",
"=",
"all_modes",
"modes",
"=",
"self",
".",
"get_available_modes",
"(",
")",
"try",
":",
"if",
"modes",
":",
"# pylint: disable=consider-using-dict-comprehension",
"simple_modes",
"=",
"dict",
"(",
"[",
"(",
"m",
".",
"get",
"(",
"\"type\"",
",",
"m",
".",
"get",
"(",
"\"name\"",
")",
")",
",",
"m",
".",
"get",
"(",
"\"id\"",
")",
")",
"for",
"m",
"in",
"modes",
"]",
")",
"all_modes",
".",
"update",
"(",
"simple_modes",
")",
"self",
".",
"_available_mode_ids",
"=",
"all_modes",
"except",
"TypeError",
":",
"_LOGGER",
".",
"debug",
"(",
"\"Did not receive a valid response. Passing..\"",
")",
"return",
"self",
".",
"_available_mode_ids"
] |
Return list of objects containing available mode name and id.
|
[
"Return",
"list",
"of",
"objects",
"containing",
"available",
"mode",
"name",
"and",
"id",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L315-L332
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.mode
|
def mode(self):
"""Return current mode key."""
if self.is_in_schedule_mode:
return "schedule"
resource = "modes"
mode_event = self.publish_and_get_event(resource)
if mode_event:
properties = mode_event.get('properties')
active_mode = properties.get('active')
modes = properties.get('modes')
if not modes:
return None
for mode in modes:
if mode.get('id') == active_mode:
return mode.get('type') \
if mode.get('type') is not None else mode.get('name')
return None
|
python
|
def mode(self):
"""Return current mode key."""
if self.is_in_schedule_mode:
return "schedule"
resource = "modes"
mode_event = self.publish_and_get_event(resource)
if mode_event:
properties = mode_event.get('properties')
active_mode = properties.get('active')
modes = properties.get('modes')
if not modes:
return None
for mode in modes:
if mode.get('id') == active_mode:
return mode.get('type') \
if mode.get('type') is not None else mode.get('name')
return None
|
[
"def",
"mode",
"(",
"self",
")",
":",
"if",
"self",
".",
"is_in_schedule_mode",
":",
"return",
"\"schedule\"",
"resource",
"=",
"\"modes\"",
"mode_event",
"=",
"self",
".",
"publish_and_get_event",
"(",
"resource",
")",
"if",
"mode_event",
":",
"properties",
"=",
"mode_event",
".",
"get",
"(",
"'properties'",
")",
"active_mode",
"=",
"properties",
".",
"get",
"(",
"'active'",
")",
"modes",
"=",
"properties",
".",
"get",
"(",
"'modes'",
")",
"if",
"not",
"modes",
":",
"return",
"None",
"for",
"mode",
"in",
"modes",
":",
"if",
"mode",
".",
"get",
"(",
"'id'",
")",
"==",
"active_mode",
":",
"return",
"mode",
".",
"get",
"(",
"'type'",
")",
"if",
"mode",
".",
"get",
"(",
"'type'",
")",
"is",
"not",
"None",
"else",
"mode",
".",
"get",
"(",
"'name'",
")",
"return",
"None"
] |
Return current mode key.
|
[
"Return",
"current",
"mode",
"key",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L340-L359
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.is_in_schedule_mode
|
def is_in_schedule_mode(self):
"""Returns True if base_station is currently on a scheduled mode."""
resource = "schedule"
mode_event = self.publish_and_get_event(resource)
if mode_event and mode_event.get("resource", None) == "schedule":
properties = mode_event.get('properties')
return properties.get("active", False)
return False
|
python
|
def is_in_schedule_mode(self):
"""Returns True if base_station is currently on a scheduled mode."""
resource = "schedule"
mode_event = self.publish_and_get_event(resource)
if mode_event and mode_event.get("resource", None) == "schedule":
properties = mode_event.get('properties')
return properties.get("active", False)
return False
|
[
"def",
"is_in_schedule_mode",
"(",
"self",
")",
":",
"resource",
"=",
"\"schedule\"",
"mode_event",
"=",
"self",
".",
"publish_and_get_event",
"(",
"resource",
")",
"if",
"mode_event",
"and",
"mode_event",
".",
"get",
"(",
"\"resource\"",
",",
"None",
")",
"==",
"\"schedule\"",
":",
"properties",
"=",
"mode_event",
".",
"get",
"(",
"'properties'",
")",
"return",
"properties",
".",
"get",
"(",
"\"active\"",
",",
"False",
")",
"return",
"False"
] |
Returns True if base_station is currently on a scheduled mode.
|
[
"Returns",
"True",
"if",
"base_station",
"is",
"currently",
"on",
"a",
"scheduled",
"mode",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L362-L369
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.get_available_modes
|
def get_available_modes(self):
"""Return a list of available mode objects for an Arlo user."""
resource = "modes"
resource_event = self.publish_and_get_event(resource)
if resource_event:
properties = resource_event.get("properties")
return properties.get("modes")
return None
|
python
|
def get_available_modes(self):
"""Return a list of available mode objects for an Arlo user."""
resource = "modes"
resource_event = self.publish_and_get_event(resource)
if resource_event:
properties = resource_event.get("properties")
return properties.get("modes")
return None
|
[
"def",
"get_available_modes",
"(",
"self",
")",
":",
"resource",
"=",
"\"modes\"",
"resource_event",
"=",
"self",
".",
"publish_and_get_event",
"(",
"resource",
")",
"if",
"resource_event",
":",
"properties",
"=",
"resource_event",
".",
"get",
"(",
"\"properties\"",
")",
"return",
"properties",
".",
"get",
"(",
"\"modes\"",
")",
"return",
"None"
] |
Return a list of available mode objects for an Arlo user.
|
[
"Return",
"a",
"list",
"of",
"available",
"mode",
"objects",
"for",
"an",
"Arlo",
"user",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L371-L379
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.get_cameras_properties
|
def get_cameras_properties(self):
"""Return camera properties."""
resource = "cameras"
resource_event = self.publish_and_get_event(resource)
if resource_event:
self._last_refresh = int(time.time())
self._camera_properties = resource_event.get('properties')
|
python
|
def get_cameras_properties(self):
"""Return camera properties."""
resource = "cameras"
resource_event = self.publish_and_get_event(resource)
if resource_event:
self._last_refresh = int(time.time())
self._camera_properties = resource_event.get('properties')
|
[
"def",
"get_cameras_properties",
"(",
"self",
")",
":",
"resource",
"=",
"\"cameras\"",
"resource_event",
"=",
"self",
".",
"publish_and_get_event",
"(",
"resource",
")",
"if",
"resource_event",
":",
"self",
".",
"_last_refresh",
"=",
"int",
"(",
"time",
".",
"time",
"(",
")",
")",
"self",
".",
"_camera_properties",
"=",
"resource_event",
".",
"get",
"(",
"'properties'",
")"
] |
Return camera properties.
|
[
"Return",
"camera",
"properties",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L388-L394
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.get_cameras_battery_level
|
def get_cameras_battery_level(self):
"""Return a list of battery levels of all cameras."""
battery_levels = {}
if not self.camera_properties:
return None
for camera in self.camera_properties:
serialnum = camera.get('serialNumber')
cam_battery = camera.get('batteryLevel')
battery_levels[serialnum] = cam_battery
return battery_levels
|
python
|
def get_cameras_battery_level(self):
"""Return a list of battery levels of all cameras."""
battery_levels = {}
if not self.camera_properties:
return None
for camera in self.camera_properties:
serialnum = camera.get('serialNumber')
cam_battery = camera.get('batteryLevel')
battery_levels[serialnum] = cam_battery
return battery_levels
|
[
"def",
"get_cameras_battery_level",
"(",
"self",
")",
":",
"battery_levels",
"=",
"{",
"}",
"if",
"not",
"self",
".",
"camera_properties",
":",
"return",
"None",
"for",
"camera",
"in",
"self",
".",
"camera_properties",
":",
"serialnum",
"=",
"camera",
".",
"get",
"(",
"'serialNumber'",
")",
"cam_battery",
"=",
"camera",
".",
"get",
"(",
"'batteryLevel'",
")",
"battery_levels",
"[",
"serialnum",
"]",
"=",
"cam_battery",
"return",
"battery_levels"
] |
Return a list of battery levels of all cameras.
|
[
"Return",
"a",
"list",
"of",
"battery",
"levels",
"of",
"all",
"cameras",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L396-L406
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.get_cameras_signal_strength
|
def get_cameras_signal_strength(self):
"""Return a list of signal strength of all cameras."""
signal_strength = {}
if not self.camera_properties:
return None
for camera in self.camera_properties:
serialnum = camera.get('serialNumber')
cam_strength = camera.get('signalStrength')
signal_strength[serialnum] = cam_strength
return signal_strength
|
python
|
def get_cameras_signal_strength(self):
"""Return a list of signal strength of all cameras."""
signal_strength = {}
if not self.camera_properties:
return None
for camera in self.camera_properties:
serialnum = camera.get('serialNumber')
cam_strength = camera.get('signalStrength')
signal_strength[serialnum] = cam_strength
return signal_strength
|
[
"def",
"get_cameras_signal_strength",
"(",
"self",
")",
":",
"signal_strength",
"=",
"{",
"}",
"if",
"not",
"self",
".",
"camera_properties",
":",
"return",
"None",
"for",
"camera",
"in",
"self",
".",
"camera_properties",
":",
"serialnum",
"=",
"camera",
".",
"get",
"(",
"'serialNumber'",
")",
"cam_strength",
"=",
"camera",
".",
"get",
"(",
"'signalStrength'",
")",
"signal_strength",
"[",
"serialnum",
"]",
"=",
"cam_strength",
"return",
"signal_strength"
] |
Return a list of signal strength of all cameras.
|
[
"Return",
"a",
"list",
"of",
"signal",
"strength",
"of",
"all",
"cameras",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L408-L418
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.get_camera_extended_properties
|
def get_camera_extended_properties(self):
"""Return camera extended properties."""
resource = 'cameras/{}'.format(self.device_id)
resource_event = self.publish_and_get_event(resource)
if resource_event is None:
return None
self._camera_extended_properties = resource_event.get('properties')
return self._camera_extended_properties
|
python
|
def get_camera_extended_properties(self):
"""Return camera extended properties."""
resource = 'cameras/{}'.format(self.device_id)
resource_event = self.publish_and_get_event(resource)
if resource_event is None:
return None
self._camera_extended_properties = resource_event.get('properties')
return self._camera_extended_properties
|
[
"def",
"get_camera_extended_properties",
"(",
"self",
")",
":",
"resource",
"=",
"'cameras/{}'",
".",
"format",
"(",
"self",
".",
"device_id",
")",
"resource_event",
"=",
"self",
".",
"publish_and_get_event",
"(",
"resource",
")",
"if",
"resource_event",
"is",
"None",
":",
"return",
"None",
"self",
".",
"_camera_extended_properties",
"=",
"resource_event",
".",
"get",
"(",
"'properties'",
")",
"return",
"self",
".",
"_camera_extended_properties"
] |
Return camera extended properties.
|
[
"Return",
"camera",
"extended",
"properties",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L427-L436
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.get_speaker_muted
|
def get_speaker_muted(self):
"""Return whether or not the speaker is muted."""
if not self.camera_extended_properties:
return None
speaker = self.camera_extended_properties.get('speaker')
if not speaker:
return None
return speaker.get('mute')
|
python
|
def get_speaker_muted(self):
"""Return whether or not the speaker is muted."""
if not self.camera_extended_properties:
return None
speaker = self.camera_extended_properties.get('speaker')
if not speaker:
return None
return speaker.get('mute')
|
[
"def",
"get_speaker_muted",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"camera_extended_properties",
":",
"return",
"None",
"speaker",
"=",
"self",
".",
"camera_extended_properties",
".",
"get",
"(",
"'speaker'",
")",
"if",
"not",
"speaker",
":",
"return",
"None",
"return",
"speaker",
".",
"get",
"(",
"'mute'",
")"
] |
Return whether or not the speaker is muted.
|
[
"Return",
"whether",
"or",
"not",
"the",
"speaker",
"is",
"muted",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L438-L447
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.get_speaker_volume
|
def get_speaker_volume(self):
"""Return the volume setting of the speaker."""
if not self.camera_extended_properties:
return None
speaker = self.camera_extended_properties.get('speaker')
if not speaker:
return None
return speaker.get('volume')
|
python
|
def get_speaker_volume(self):
"""Return the volume setting of the speaker."""
if not self.camera_extended_properties:
return None
speaker = self.camera_extended_properties.get('speaker')
if not speaker:
return None
return speaker.get('volume')
|
[
"def",
"get_speaker_volume",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"camera_extended_properties",
":",
"return",
"None",
"speaker",
"=",
"self",
".",
"camera_extended_properties",
".",
"get",
"(",
"'speaker'",
")",
"if",
"not",
"speaker",
":",
"return",
"None",
"return",
"speaker",
".",
"get",
"(",
"'volume'",
")"
] |
Return the volume setting of the speaker.
|
[
"Return",
"the",
"volume",
"setting",
"of",
"the",
"speaker",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L449-L458
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.properties
|
def properties(self):
"""Return the base station info."""
resource = "basestation"
basestn_event = self.publish_and_get_event(resource)
if basestn_event:
return basestn_event.get('properties')
return None
|
python
|
def properties(self):
"""Return the base station info."""
resource = "basestation"
basestn_event = self.publish_and_get_event(resource)
if basestn_event:
return basestn_event.get('properties')
return None
|
[
"def",
"properties",
"(",
"self",
")",
":",
"resource",
"=",
"\"basestation\"",
"basestn_event",
"=",
"self",
".",
"publish_and_get_event",
"(",
"resource",
")",
"if",
"basestn_event",
":",
"return",
"basestn_event",
".",
"get",
"(",
"'properties'",
")",
"return",
"None"
] |
Return the base station info.
|
[
"Return",
"the",
"base",
"station",
"info",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L486-L493
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.get_cameras_rules
|
def get_cameras_rules(self):
"""Return the camera rules."""
resource = "rules"
rules_event = self.publish_and_get_event(resource)
if rules_event:
return rules_event.get('properties')
return None
|
python
|
def get_cameras_rules(self):
"""Return the camera rules."""
resource = "rules"
rules_event = self.publish_and_get_event(resource)
if rules_event:
return rules_event.get('properties')
return None
|
[
"def",
"get_cameras_rules",
"(",
"self",
")",
":",
"resource",
"=",
"\"rules\"",
"rules_event",
"=",
"self",
".",
"publish_and_get_event",
"(",
"resource",
")",
"if",
"rules_event",
":",
"return",
"rules_event",
".",
"get",
"(",
"'properties'",
")",
"return",
"None"
] |
Return the camera rules.
|
[
"Return",
"the",
"camera",
"rules",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L495-L502
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.get_cameras_schedule
|
def get_cameras_schedule(self):
"""Return the schedule set for cameras."""
resource = "schedule"
schedule_event = self.publish_and_get_event(resource)
if schedule_event:
return schedule_event.get('properties')
return None
|
python
|
def get_cameras_schedule(self):
"""Return the schedule set for cameras."""
resource = "schedule"
schedule_event = self.publish_and_get_event(resource)
if schedule_event:
return schedule_event.get('properties')
return None
|
[
"def",
"get_cameras_schedule",
"(",
"self",
")",
":",
"resource",
"=",
"\"schedule\"",
"schedule_event",
"=",
"self",
".",
"publish_and_get_event",
"(",
"resource",
")",
"if",
"schedule_event",
":",
"return",
"schedule_event",
".",
"get",
"(",
"'properties'",
")",
"return",
"None"
] |
Return the schedule set for cameras.
|
[
"Return",
"the",
"schedule",
"set",
"for",
"cameras",
"."
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L504-L511
|
train
|
tchellomello/python-arlo
|
pyarlo/base_station.py
|
ArloBaseStation.get_ambient_sensor_data
|
def get_ambient_sensor_data(self):
"""Refresh ambient sensor history"""
resource = 'cameras/{}/ambientSensors/history'.format(self.device_id)
history_event = self.publish_and_get_event(resource)
if history_event is None:
return None
properties = history_event.get('properties')
self._ambient_sensor_data = \
ArloBaseStation._decode_sensor_data(properties)
return self._ambient_sensor_data
|
python
|
def get_ambient_sensor_data(self):
"""Refresh ambient sensor history"""
resource = 'cameras/{}/ambientSensors/history'.format(self.device_id)
history_event = self.publish_and_get_event(resource)
if history_event is None:
return None
properties = history_event.get('properties')
self._ambient_sensor_data = \
ArloBaseStation._decode_sensor_data(properties)
return self._ambient_sensor_data
|
[
"def",
"get_ambient_sensor_data",
"(",
"self",
")",
":",
"resource",
"=",
"'cameras/{}/ambientSensors/history'",
".",
"format",
"(",
"self",
".",
"device_id",
")",
"history_event",
"=",
"self",
".",
"publish_and_get_event",
"(",
"resource",
")",
"if",
"history_event",
"is",
"None",
":",
"return",
"None",
"properties",
"=",
"history_event",
".",
"get",
"(",
"'properties'",
")",
"self",
".",
"_ambient_sensor_data",
"=",
"ArloBaseStation",
".",
"_decode_sensor_data",
"(",
"properties",
")",
"return",
"self",
".",
"_ambient_sensor_data"
] |
Refresh ambient sensor history
|
[
"Refresh",
"ambient",
"sensor",
"history"
] |
db70aeb81705309c56ad32bbab1094f6cd146524
|
https://github.com/tchellomello/python-arlo/blob/db70aeb81705309c56ad32bbab1094f6cd146524/pyarlo/base_station.py#L543-L556
|
train
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.