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 listlengths 20 707 | docstring stringlengths 3 17.3k | docstring_tokens listlengths 3 222 | sha stringlengths 40 40 | url stringlengths 87 242 | partition stringclasses 1 value | idx int64 0 252k |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
sosreport/sos | sos/plugins/__init__.py | Plugin.collect | def collect(self):
"""Collect the data for a plugin."""
start = time()
self._collect_copy_specs()
self._collect_cmd_output()
self._collect_strings()
fields = (self.name(), time() - start)
self._log_debug("collected plugin '%s' in %s" % fields) | python | def collect(self):
"""Collect the data for a plugin."""
start = time()
self._collect_copy_specs()
self._collect_cmd_output()
self._collect_strings()
fields = (self.name(), time() - start)
self._log_debug("collected plugin '%s' in %s" % fields) | [
"def",
"collect",
"(",
"self",
")",
":",
"start",
"=",
"time",
"(",
")",
"self",
".",
"_collect_copy_specs",
"(",
")",
"self",
".",
"_collect_cmd_output",
"(",
")",
"self",
".",
"_collect_strings",
"(",
")",
"fields",
"=",
"(",
"self",
".",
"name",
"("... | Collect the data for a plugin. | [
"Collect",
"the",
"data",
"for",
"a",
"plugin",
"."
] | 2ebc04da53dc871c8dd5243567afa4f8592dca29 | https://github.com/sosreport/sos/blob/2ebc04da53dc871c8dd5243567afa4f8592dca29/sos/plugins/__init__.py#L1202-L1209 | train | 220,600 |
sosreport/sos | sos/plugins/__init__.py | Plugin.get_description | def get_description(self):
""" This function will return the description for the plugin"""
try:
if hasattr(self, '__doc__') and self.__doc__:
return self.__doc__.strip()
return super(self.__class__, self).__doc__.strip()
except Exception:
return "<no description available>" | python | def get_description(self):
""" This function will return the description for the plugin"""
try:
if hasattr(self, '__doc__') and self.__doc__:
return self.__doc__.strip()
return super(self.__class__, self).__doc__.strip()
except Exception:
return "<no description available>" | [
"def",
"get_description",
"(",
"self",
")",
":",
"try",
":",
"if",
"hasattr",
"(",
"self",
",",
"'__doc__'",
")",
"and",
"self",
".",
"__doc__",
":",
"return",
"self",
".",
"__doc__",
".",
"strip",
"(",
")",
"return",
"super",
"(",
"self",
".",
"__cl... | This function will return the description for the plugin | [
"This",
"function",
"will",
"return",
"the",
"description",
"for",
"the",
"plugin"
] | 2ebc04da53dc871c8dd5243567afa4f8592dca29 | https://github.com/sosreport/sos/blob/2ebc04da53dc871c8dd5243567afa4f8592dca29/sos/plugins/__init__.py#L1211-L1218 | train | 220,601 |
sosreport/sos | sos/plugins/__init__.py | Plugin.check_enabled | def check_enabled(self):
"""This method will be used to verify that a plugin should execute
given the condition of the underlying environment.
The default implementation will return True if none of class.files,
class.packages, nor class.commands is specified. If any of these is
specified the plugin will check for the existence of any of the
corresponding paths, packages or commands and return True if any
are present.
For SCLPlugin subclasses, it will check whether the plugin can be run
for any of installed SCLs. If so, it will store names of these SCLs
on the plugin class in addition to returning True.
For plugins with more complex enablement checks this method may be
overridden.
"""
# some files or packages have been specified for this package
if any([self.files, self.packages, self.commands, self.kernel_mods,
self.services]):
if isinstance(self.files, six.string_types):
self.files = [self.files]
if isinstance(self.packages, six.string_types):
self.packages = [self.packages]
if isinstance(self.commands, six.string_types):
self.commands = [self.commands]
if isinstance(self.kernel_mods, six.string_types):
self.kernel_mods = [self.kernel_mods]
if isinstance(self.services, six.string_types):
self.services = [self.services]
if isinstance(self, SCLPlugin):
# save SCLs that match files or packages
type(self)._scls_matched = []
for scl in self._get_scls():
files = [f % {"scl_name": scl} for f in self.files]
packages = [p % {"scl_name": scl} for p in self.packages]
commands = [c % {"scl_name": scl} for c in self.commands]
services = [s % {"scl_name": scl} for s in self.services]
if self._check_plugin_triggers(files,
packages,
commands,
services):
type(self)._scls_matched.append(scl)
return len(type(self)._scls_matched) > 0
return self._check_plugin_triggers(self.files,
self.packages,
self.commands,
self.services)
if isinstance(self, SCLPlugin):
# if files and packages weren't specified, we take all SCLs
type(self)._scls_matched = self._get_scls()
return True | python | def check_enabled(self):
"""This method will be used to verify that a plugin should execute
given the condition of the underlying environment.
The default implementation will return True if none of class.files,
class.packages, nor class.commands is specified. If any of these is
specified the plugin will check for the existence of any of the
corresponding paths, packages or commands and return True if any
are present.
For SCLPlugin subclasses, it will check whether the plugin can be run
for any of installed SCLs. If so, it will store names of these SCLs
on the plugin class in addition to returning True.
For plugins with more complex enablement checks this method may be
overridden.
"""
# some files or packages have been specified for this package
if any([self.files, self.packages, self.commands, self.kernel_mods,
self.services]):
if isinstance(self.files, six.string_types):
self.files = [self.files]
if isinstance(self.packages, six.string_types):
self.packages = [self.packages]
if isinstance(self.commands, six.string_types):
self.commands = [self.commands]
if isinstance(self.kernel_mods, six.string_types):
self.kernel_mods = [self.kernel_mods]
if isinstance(self.services, six.string_types):
self.services = [self.services]
if isinstance(self, SCLPlugin):
# save SCLs that match files or packages
type(self)._scls_matched = []
for scl in self._get_scls():
files = [f % {"scl_name": scl} for f in self.files]
packages = [p % {"scl_name": scl} for p in self.packages]
commands = [c % {"scl_name": scl} for c in self.commands]
services = [s % {"scl_name": scl} for s in self.services]
if self._check_plugin_triggers(files,
packages,
commands,
services):
type(self)._scls_matched.append(scl)
return len(type(self)._scls_matched) > 0
return self._check_plugin_triggers(self.files,
self.packages,
self.commands,
self.services)
if isinstance(self, SCLPlugin):
# if files and packages weren't specified, we take all SCLs
type(self)._scls_matched = self._get_scls()
return True | [
"def",
"check_enabled",
"(",
"self",
")",
":",
"# some files or packages have been specified for this package",
"if",
"any",
"(",
"[",
"self",
".",
"files",
",",
"self",
".",
"packages",
",",
"self",
".",
"commands",
",",
"self",
".",
"kernel_mods",
",",
"self",... | This method will be used to verify that a plugin should execute
given the condition of the underlying environment.
The default implementation will return True if none of class.files,
class.packages, nor class.commands is specified. If any of these is
specified the plugin will check for the existence of any of the
corresponding paths, packages or commands and return True if any
are present.
For SCLPlugin subclasses, it will check whether the plugin can be run
for any of installed SCLs. If so, it will store names of these SCLs
on the plugin class in addition to returning True.
For plugins with more complex enablement checks this method may be
overridden. | [
"This",
"method",
"will",
"be",
"used",
"to",
"verify",
"that",
"a",
"plugin",
"should",
"execute",
"given",
"the",
"condition",
"of",
"the",
"underlying",
"environment",
"."
] | 2ebc04da53dc871c8dd5243567afa4f8592dca29 | https://github.com/sosreport/sos/blob/2ebc04da53dc871c8dd5243567afa4f8592dca29/sos/plugins/__init__.py#L1220-L1279 | train | 220,602 |
sosreport/sos | sos/plugins/__init__.py | Plugin.report | def report(self):
""" Present all information that was gathered in an html file that
allows browsing the results.
"""
# make this prettier
html = u'<hr/><a name="%s"></a>\n' % self.name()
# Intro
html = html + "<h2> Plugin <em>" + self.name() + "</em></h2>\n"
# Files
if len(self.copied_files):
html = html + "<p>Files copied:<br><ul>\n"
for afile in self.copied_files:
html = html + '<li><a href="%s">%s</a>' % \
(u'..' + _to_u(afile['dstpath']), _to_u(afile['srcpath']))
if afile['symlink'] == "yes":
html = html + " (symlink to %s)" % _to_u(afile['pointsto'])
html = html + '</li>\n'
html = html + "</ul></p>\n"
# Command Output
if len(self.executed_commands):
html = html + "<p>Commands Executed:<br><ul>\n"
# convert file name to relative path from our root
# don't use relpath - these are HTML paths not OS paths.
for cmd in self.executed_commands:
if cmd["file"] and len(cmd["file"]):
cmd_rel_path = u"../" + _to_u(self.commons['cmddir']) \
+ "/" + _to_u(cmd['file'])
html = html + '<li><a href="%s">%s</a></li>\n' % \
(cmd_rel_path, _to_u(cmd['exe']))
else:
html = html + '<li>%s</li>\n' % (_to_u(cmd['exe']))
html = html + "</ul></p>\n"
# Alerts
if len(self.alerts):
html = html + "<p>Alerts:<br><ul>\n"
for alert in self.alerts:
html = html + '<li>%s</li>\n' % _to_u(alert)
html = html + "</ul></p>\n"
# Custom Text
if self.custom_text != "":
html = html + "<p>Additional Information:<br>\n"
html = html + _to_u(self.custom_text) + "</p>\n"
if six.PY2:
return html.encode('utf8')
else:
return html | python | def report(self):
""" Present all information that was gathered in an html file that
allows browsing the results.
"""
# make this prettier
html = u'<hr/><a name="%s"></a>\n' % self.name()
# Intro
html = html + "<h2> Plugin <em>" + self.name() + "</em></h2>\n"
# Files
if len(self.copied_files):
html = html + "<p>Files copied:<br><ul>\n"
for afile in self.copied_files:
html = html + '<li><a href="%s">%s</a>' % \
(u'..' + _to_u(afile['dstpath']), _to_u(afile['srcpath']))
if afile['symlink'] == "yes":
html = html + " (symlink to %s)" % _to_u(afile['pointsto'])
html = html + '</li>\n'
html = html + "</ul></p>\n"
# Command Output
if len(self.executed_commands):
html = html + "<p>Commands Executed:<br><ul>\n"
# convert file name to relative path from our root
# don't use relpath - these are HTML paths not OS paths.
for cmd in self.executed_commands:
if cmd["file"] and len(cmd["file"]):
cmd_rel_path = u"../" + _to_u(self.commons['cmddir']) \
+ "/" + _to_u(cmd['file'])
html = html + '<li><a href="%s">%s</a></li>\n' % \
(cmd_rel_path, _to_u(cmd['exe']))
else:
html = html + '<li>%s</li>\n' % (_to_u(cmd['exe']))
html = html + "</ul></p>\n"
# Alerts
if len(self.alerts):
html = html + "<p>Alerts:<br><ul>\n"
for alert in self.alerts:
html = html + '<li>%s</li>\n' % _to_u(alert)
html = html + "</ul></p>\n"
# Custom Text
if self.custom_text != "":
html = html + "<p>Additional Information:<br>\n"
html = html + _to_u(self.custom_text) + "</p>\n"
if six.PY2:
return html.encode('utf8')
else:
return html | [
"def",
"report",
"(",
"self",
")",
":",
"# make this prettier",
"html",
"=",
"u'<hr/><a name=\"%s\"></a>\\n'",
"%",
"self",
".",
"name",
"(",
")",
"# Intro",
"html",
"=",
"html",
"+",
"\"<h2> Plugin <em>\"",
"+",
"self",
".",
"name",
"(",
")",
"+",
"\"</em><... | Present all information that was gathered in an html file that
allows browsing the results. | [
"Present",
"all",
"information",
"that",
"was",
"gathered",
"in",
"an",
"html",
"file",
"that",
"allows",
"browsing",
"the",
"results",
"."
] | 2ebc04da53dc871c8dd5243567afa4f8592dca29 | https://github.com/sosreport/sos/blob/2ebc04da53dc871c8dd5243567afa4f8592dca29/sos/plugins/__init__.py#L1323-L1374 | train | 220,603 |
sosreport/sos | sos/plugins/__init__.py | Plugin.get_process_pids | def get_process_pids(self, process):
"""Returns PIDs of all processes with process name.
If the process doesn't exist, returns an empty list"""
pids = []
cmd_line_glob = "/proc/[0-9]*/cmdline"
cmd_line_paths = glob.glob(cmd_line_glob)
for path in cmd_line_paths:
try:
with open(path, 'r') as f:
cmd_line = f.read().strip()
if process in cmd_line:
pids.append(path.split("/")[2])
except IOError as e:
continue
return pids | python | def get_process_pids(self, process):
"""Returns PIDs of all processes with process name.
If the process doesn't exist, returns an empty list"""
pids = []
cmd_line_glob = "/proc/[0-9]*/cmdline"
cmd_line_paths = glob.glob(cmd_line_glob)
for path in cmd_line_paths:
try:
with open(path, 'r') as f:
cmd_line = f.read().strip()
if process in cmd_line:
pids.append(path.split("/")[2])
except IOError as e:
continue
return pids | [
"def",
"get_process_pids",
"(",
"self",
",",
"process",
")",
":",
"pids",
"=",
"[",
"]",
"cmd_line_glob",
"=",
"\"/proc/[0-9]*/cmdline\"",
"cmd_line_paths",
"=",
"glob",
".",
"glob",
"(",
"cmd_line_glob",
")",
"for",
"path",
"in",
"cmd_line_paths",
":",
"try",... | Returns PIDs of all processes with process name.
If the process doesn't exist, returns an empty list | [
"Returns",
"PIDs",
"of",
"all",
"processes",
"with",
"process",
"name",
".",
"If",
"the",
"process",
"doesn",
"t",
"exist",
"returns",
"an",
"empty",
"list"
] | 2ebc04da53dc871c8dd5243567afa4f8592dca29 | https://github.com/sosreport/sos/blob/2ebc04da53dc871c8dd5243567afa4f8592dca29/sos/plugins/__init__.py#L1392-L1406 | train | 220,604 |
sosreport/sos | sos/plugins/__init__.py | SCLPlugin.convert_cmd_scl | def convert_cmd_scl(self, scl, cmd):
"""wrapping command in "scl enable" call and adds proper PATH
"""
# load default SCL prefix to PATH
prefix = self.policy.get_default_scl_prefix()
# read prefix from /etc/scl/prefixes/${scl} and strip trailing '\n'
try:
prefix = open('/etc/scl/prefixes/%s' % scl, 'r').read()\
.rstrip('\n')
except Exception as e:
self._log_error("Failed to find prefix for SCL %s, using %s"
% (scl, prefix))
# expand PATH by equivalent prefixes under the SCL tree
path = os.environ["PATH"]
for p in path.split(':'):
path = '%s/%s%s:%s' % (prefix, scl, p, path)
scl_cmd = "scl enable %s \"PATH=%s %s\"" % (scl, path, cmd)
return scl_cmd | python | def convert_cmd_scl(self, scl, cmd):
"""wrapping command in "scl enable" call and adds proper PATH
"""
# load default SCL prefix to PATH
prefix = self.policy.get_default_scl_prefix()
# read prefix from /etc/scl/prefixes/${scl} and strip trailing '\n'
try:
prefix = open('/etc/scl/prefixes/%s' % scl, 'r').read()\
.rstrip('\n')
except Exception as e:
self._log_error("Failed to find prefix for SCL %s, using %s"
% (scl, prefix))
# expand PATH by equivalent prefixes under the SCL tree
path = os.environ["PATH"]
for p in path.split(':'):
path = '%s/%s%s:%s' % (prefix, scl, p, path)
scl_cmd = "scl enable %s \"PATH=%s %s\"" % (scl, path, cmd)
return scl_cmd | [
"def",
"convert_cmd_scl",
"(",
"self",
",",
"scl",
",",
"cmd",
")",
":",
"# load default SCL prefix to PATH",
"prefix",
"=",
"self",
".",
"policy",
".",
"get_default_scl_prefix",
"(",
")",
"# read prefix from /etc/scl/prefixes/${scl} and strip trailing '\\n'",
"try",
":",... | wrapping command in "scl enable" call and adds proper PATH | [
"wrapping",
"command",
"in",
"scl",
"enable",
"call",
"and",
"adds",
"proper",
"PATH"
] | 2ebc04da53dc871c8dd5243567afa4f8592dca29 | https://github.com/sosreport/sos/blob/2ebc04da53dc871c8dd5243567afa4f8592dca29/sos/plugins/__init__.py#L1448-L1467 | train | 220,605 |
sosreport/sos | sos/plugins/__init__.py | SCLPlugin.add_cmd_output_scl | def add_cmd_output_scl(self, scl, cmds, **kwargs):
"""Same as add_cmd_output, except that it wraps command in
"scl enable" call and sets proper PATH.
"""
if isinstance(cmds, six.string_types):
cmds = [cmds]
scl_cmds = []
for cmd in cmds:
scl_cmds.append(self.convert_cmd_scl(scl, cmd))
self.add_cmd_output(scl_cmds, **kwargs) | python | def add_cmd_output_scl(self, scl, cmds, **kwargs):
"""Same as add_cmd_output, except that it wraps command in
"scl enable" call and sets proper PATH.
"""
if isinstance(cmds, six.string_types):
cmds = [cmds]
scl_cmds = []
for cmd in cmds:
scl_cmds.append(self.convert_cmd_scl(scl, cmd))
self.add_cmd_output(scl_cmds, **kwargs) | [
"def",
"add_cmd_output_scl",
"(",
"self",
",",
"scl",
",",
"cmds",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"isinstance",
"(",
"cmds",
",",
"six",
".",
"string_types",
")",
":",
"cmds",
"=",
"[",
"cmds",
"]",
"scl_cmds",
"=",
"[",
"]",
"for",
"cmd"... | Same as add_cmd_output, except that it wraps command in
"scl enable" call and sets proper PATH. | [
"Same",
"as",
"add_cmd_output",
"except",
"that",
"it",
"wraps",
"command",
"in",
"scl",
"enable",
"call",
"and",
"sets",
"proper",
"PATH",
"."
] | 2ebc04da53dc871c8dd5243567afa4f8592dca29 | https://github.com/sosreport/sos/blob/2ebc04da53dc871c8dd5243567afa4f8592dca29/sos/plugins/__init__.py#L1469-L1478 | train | 220,606 |
sosreport/sos | sos/plugins/__init__.py | SCLPlugin.add_copy_spec_scl | def add_copy_spec_scl(self, scl, copyspecs):
"""Same as add_copy_spec, except that it prepends path to SCL root
to "copyspecs".
"""
if isinstance(copyspecs, six.string_types):
copyspecs = [copyspecs]
scl_copyspecs = []
for copyspec in copyspecs:
scl_copyspecs.append(self.convert_copyspec_scl(scl, copyspec))
self.add_copy_spec(scl_copyspecs) | python | def add_copy_spec_scl(self, scl, copyspecs):
"""Same as add_copy_spec, except that it prepends path to SCL root
to "copyspecs".
"""
if isinstance(copyspecs, six.string_types):
copyspecs = [copyspecs]
scl_copyspecs = []
for copyspec in copyspecs:
scl_copyspecs.append(self.convert_copyspec_scl(scl, copyspec))
self.add_copy_spec(scl_copyspecs) | [
"def",
"add_copy_spec_scl",
"(",
"self",
",",
"scl",
",",
"copyspecs",
")",
":",
"if",
"isinstance",
"(",
"copyspecs",
",",
"six",
".",
"string_types",
")",
":",
"copyspecs",
"=",
"[",
"copyspecs",
"]",
"scl_copyspecs",
"=",
"[",
"]",
"for",
"copyspec",
... | Same as add_copy_spec, except that it prepends path to SCL root
to "copyspecs". | [
"Same",
"as",
"add_copy_spec",
"except",
"that",
"it",
"prepends",
"path",
"to",
"SCL",
"root",
"to",
"copyspecs",
"."
] | 2ebc04da53dc871c8dd5243567afa4f8592dca29 | https://github.com/sosreport/sos/blob/2ebc04da53dc871c8dd5243567afa4f8592dca29/sos/plugins/__init__.py#L1492-L1501 | train | 220,607 |
sosreport/sos | sos/plugins/__init__.py | SCLPlugin.add_copy_spec_limit_scl | def add_copy_spec_limit_scl(self, scl, copyspec, **kwargs):
"""Same as add_copy_spec_limit, except that it prepends path to SCL
root to "copyspec".
"""
self.add_copy_spec_limit(
self.convert_copyspec_scl(scl, copyspec),
**kwargs
) | python | def add_copy_spec_limit_scl(self, scl, copyspec, **kwargs):
"""Same as add_copy_spec_limit, except that it prepends path to SCL
root to "copyspec".
"""
self.add_copy_spec_limit(
self.convert_copyspec_scl(scl, copyspec),
**kwargs
) | [
"def",
"add_copy_spec_limit_scl",
"(",
"self",
",",
"scl",
",",
"copyspec",
",",
"*",
"*",
"kwargs",
")",
":",
"self",
".",
"add_copy_spec_limit",
"(",
"self",
".",
"convert_copyspec_scl",
"(",
"scl",
",",
"copyspec",
")",
",",
"*",
"*",
"kwargs",
")"
] | Same as add_copy_spec_limit, except that it prepends path to SCL
root to "copyspec". | [
"Same",
"as",
"add_copy_spec_limit",
"except",
"that",
"it",
"prepends",
"path",
"to",
"SCL",
"root",
"to",
"copyspec",
"."
] | 2ebc04da53dc871c8dd5243567afa4f8592dca29 | https://github.com/sosreport/sos/blob/2ebc04da53dc871c8dd5243567afa4f8592dca29/sos/plugins/__init__.py#L1503-L1510 | train | 220,608 |
sosreport/sos | sos/plugins/veritas.py | Veritas.setup | def setup(self):
""" interface with vrtsexplorer to capture veritas related data """
r = self.call_ext_prog(self.get_option("script"))
if r['status'] == 0:
tarfile = ""
for line in r['output']:
line = line.strip()
tarfile = self.do_regex_find_all(r"ftp (.*tar.gz)", line)
if len(tarfile) == 1:
self.add_copy_spec(tarfile[0]) | python | def setup(self):
""" interface with vrtsexplorer to capture veritas related data """
r = self.call_ext_prog(self.get_option("script"))
if r['status'] == 0:
tarfile = ""
for line in r['output']:
line = line.strip()
tarfile = self.do_regex_find_all(r"ftp (.*tar.gz)", line)
if len(tarfile) == 1:
self.add_copy_spec(tarfile[0]) | [
"def",
"setup",
"(",
"self",
")",
":",
"r",
"=",
"self",
".",
"call_ext_prog",
"(",
"self",
".",
"get_option",
"(",
"\"script\"",
")",
")",
"if",
"r",
"[",
"'status'",
"]",
"==",
"0",
":",
"tarfile",
"=",
"\"\"",
"for",
"line",
"in",
"r",
"[",
"'... | interface with vrtsexplorer to capture veritas related data | [
"interface",
"with",
"vrtsexplorer",
"to",
"capture",
"veritas",
"related",
"data"
] | 2ebc04da53dc871c8dd5243567afa4f8592dca29 | https://github.com/sosreport/sos/blob/2ebc04da53dc871c8dd5243567afa4f8592dca29/sos/plugins/veritas.py#L28-L37 | train | 220,609 |
sosreport/sos | sos/plugins/openstack_ansible.py | OpenStackAnsible.postproc | def postproc(self):
"""Remove sensitive keys and passwords from YAML files."""
secrets_files = [
"/etc/openstack_deploy/user_secrets.yml",
"/etc/rpc_deploy/user_secrets.yml"
]
regexp = r"(?m)^\s*#*([\w_]*:\s*).*"
for secrets_file in secrets_files:
self.do_path_regex_sub(
secrets_file,
regexp,
r"\1*********") | python | def postproc(self):
"""Remove sensitive keys and passwords from YAML files."""
secrets_files = [
"/etc/openstack_deploy/user_secrets.yml",
"/etc/rpc_deploy/user_secrets.yml"
]
regexp = r"(?m)^\s*#*([\w_]*:\s*).*"
for secrets_file in secrets_files:
self.do_path_regex_sub(
secrets_file,
regexp,
r"\1*********") | [
"def",
"postproc",
"(",
"self",
")",
":",
"secrets_files",
"=",
"[",
"\"/etc/openstack_deploy/user_secrets.yml\"",
",",
"\"/etc/rpc_deploy/user_secrets.yml\"",
"]",
"regexp",
"=",
"r\"(?m)^\\s*#*([\\w_]*:\\s*).*\"",
"for",
"secrets_file",
"in",
"secrets_files",
":",
"self",... | Remove sensitive keys and passwords from YAML files. | [
"Remove",
"sensitive",
"keys",
"and",
"passwords",
"from",
"YAML",
"files",
"."
] | 2ebc04da53dc871c8dd5243567afa4f8592dca29 | https://github.com/sosreport/sos/blob/2ebc04da53dc871c8dd5243567afa4f8592dca29/sos/plugins/openstack_ansible.py#L30-L41 | train | 220,610 |
timothycrosley/isort | isort/main.py | ISortCommand.finalize_options | def finalize_options(self) -> None:
"Get options from config files."
self.arguments = {} # type: Dict[str, Any]
computed_settings = from_path(os.getcwd())
for key, value in computed_settings.items():
self.arguments[key] = value | python | def finalize_options(self) -> None:
"Get options from config files."
self.arguments = {} # type: Dict[str, Any]
computed_settings = from_path(os.getcwd())
for key, value in computed_settings.items():
self.arguments[key] = value | [
"def",
"finalize_options",
"(",
"self",
")",
"->",
"None",
":",
"self",
".",
"arguments",
"=",
"{",
"}",
"# type: Dict[str, Any]",
"computed_settings",
"=",
"from_path",
"(",
"os",
".",
"getcwd",
"(",
")",
")",
"for",
"key",
",",
"value",
"in",
"computed_s... | Get options from config files. | [
"Get",
"options",
"from",
"config",
"files",
"."
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/main.py#L131-L136 | train | 220,611 |
timothycrosley/isort | isort/main.py | ISortCommand.distribution_files | def distribution_files(self) -> Iterator[str]:
"""Find distribution packages."""
# This is verbatim from flake8
if self.distribution.packages:
package_dirs = self.distribution.package_dir or {}
for package in self.distribution.packages:
pkg_dir = package
if package in package_dirs:
pkg_dir = package_dirs[package]
elif '' in package_dirs:
pkg_dir = package_dirs[''] + os.path.sep + pkg_dir
yield pkg_dir.replace('.', os.path.sep)
if self.distribution.py_modules:
for filename in self.distribution.py_modules:
yield "%s.py" % filename
# Don't miss the setup.py file itself
yield "setup.py" | python | def distribution_files(self) -> Iterator[str]:
"""Find distribution packages."""
# This is verbatim from flake8
if self.distribution.packages:
package_dirs = self.distribution.package_dir or {}
for package in self.distribution.packages:
pkg_dir = package
if package in package_dirs:
pkg_dir = package_dirs[package]
elif '' in package_dirs:
pkg_dir = package_dirs[''] + os.path.sep + pkg_dir
yield pkg_dir.replace('.', os.path.sep)
if self.distribution.py_modules:
for filename in self.distribution.py_modules:
yield "%s.py" % filename
# Don't miss the setup.py file itself
yield "setup.py" | [
"def",
"distribution_files",
"(",
"self",
")",
"->",
"Iterator",
"[",
"str",
"]",
":",
"# This is verbatim from flake8",
"if",
"self",
".",
"distribution",
".",
"packages",
":",
"package_dirs",
"=",
"self",
".",
"distribution",
".",
"package_dir",
"or",
"{",
"... | Find distribution packages. | [
"Find",
"distribution",
"packages",
"."
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/main.py#L138-L155 | train | 220,612 |
timothycrosley/isort | isort/utils.py | chdir | def chdir(path: str) -> Iterator[None]:
"""Context manager for changing dir and restoring previous workdir after exit.
"""
curdir = os.getcwd()
os.chdir(path)
try:
yield
finally:
os.chdir(curdir) | python | def chdir(path: str) -> Iterator[None]:
"""Context manager for changing dir and restoring previous workdir after exit.
"""
curdir = os.getcwd()
os.chdir(path)
try:
yield
finally:
os.chdir(curdir) | [
"def",
"chdir",
"(",
"path",
":",
"str",
")",
"->",
"Iterator",
"[",
"None",
"]",
":",
"curdir",
"=",
"os",
".",
"getcwd",
"(",
")",
"os",
".",
"chdir",
"(",
"path",
")",
"try",
":",
"yield",
"finally",
":",
"os",
".",
"chdir",
"(",
"curdir",
"... | Context manager for changing dir and restoring previous workdir after exit. | [
"Context",
"manager",
"for",
"changing",
"dir",
"and",
"restoring",
"previous",
"workdir",
"after",
"exit",
"."
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/utils.py#L23-L31 | train | 220,613 |
timothycrosley/isort | isort/utils.py | union | def union(a: Iterable[Any], b: Iterable[Any]) -> List[Any]:
""" Return a list of items that are in `a` or `b`
"""
u = [] # type: List[Any]
for item in a:
if item not in u:
u.append(item)
for item in b:
if item not in u:
u.append(item)
return u | python | def union(a: Iterable[Any], b: Iterable[Any]) -> List[Any]:
""" Return a list of items that are in `a` or `b`
"""
u = [] # type: List[Any]
for item in a:
if item not in u:
u.append(item)
for item in b:
if item not in u:
u.append(item)
return u | [
"def",
"union",
"(",
"a",
":",
"Iterable",
"[",
"Any",
"]",
",",
"b",
":",
"Iterable",
"[",
"Any",
"]",
")",
"->",
"List",
"[",
"Any",
"]",
":",
"u",
"=",
"[",
"]",
"# type: List[Any]",
"for",
"item",
"in",
"a",
":",
"if",
"item",
"not",
"in",
... | Return a list of items that are in `a` or `b` | [
"Return",
"a",
"list",
"of",
"items",
"that",
"are",
"in",
"a",
"or",
"b"
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/utils.py#L34-L44 | train | 220,614 |
timothycrosley/isort | isort/utils.py | difference | def difference(a: Iterable[Any], b: Container[Any]) -> List[Any]:
""" Return a list of items from `a` that are not in `b`.
"""
d = []
for item in a:
if item not in b:
d.append(item)
return d | python | def difference(a: Iterable[Any], b: Container[Any]) -> List[Any]:
""" Return a list of items from `a` that are not in `b`.
"""
d = []
for item in a:
if item not in b:
d.append(item)
return d | [
"def",
"difference",
"(",
"a",
":",
"Iterable",
"[",
"Any",
"]",
",",
"b",
":",
"Container",
"[",
"Any",
"]",
")",
"->",
"List",
"[",
"Any",
"]",
":",
"d",
"=",
"[",
"]",
"for",
"item",
"in",
"a",
":",
"if",
"item",
"not",
"in",
"b",
":",
"... | Return a list of items from `a` that are not in `b`. | [
"Return",
"a",
"list",
"of",
"items",
"from",
"a",
"that",
"are",
"not",
"in",
"b",
"."
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/utils.py#L47-L54 | train | 220,615 |
timothycrosley/isort | kate_plugin/isort_plugin.py | sort_kate_imports | def sort_kate_imports(add_imports=(), remove_imports=()):
"""Sorts imports within Kate while maintaining cursor position and selection, even if length of file changes."""
document = kate.activeDocument()
view = document.activeView()
position = view.cursorPosition()
selection = view.selectionRange()
sorter = SortImports(file_contents=document.text(), add_imports=add_imports, remove_imports=remove_imports,
settings_path=os.path.dirname(os.path.abspath(str(document.url().path()))))
document.setText(sorter.output)
position.setLine(position.line() + sorter.length_change)
if selection:
start = selection.start()
start.setLine(start.line() + sorter.length_change)
end = selection.end()
end.setLine(end.line() + sorter.length_change)
selection.setRange(start, end)
view.setSelection(selection)
view.setCursorPosition(position) | python | def sort_kate_imports(add_imports=(), remove_imports=()):
"""Sorts imports within Kate while maintaining cursor position and selection, even if length of file changes."""
document = kate.activeDocument()
view = document.activeView()
position = view.cursorPosition()
selection = view.selectionRange()
sorter = SortImports(file_contents=document.text(), add_imports=add_imports, remove_imports=remove_imports,
settings_path=os.path.dirname(os.path.abspath(str(document.url().path()))))
document.setText(sorter.output)
position.setLine(position.line() + sorter.length_change)
if selection:
start = selection.start()
start.setLine(start.line() + sorter.length_change)
end = selection.end()
end.setLine(end.line() + sorter.length_change)
selection.setRange(start, end)
view.setSelection(selection)
view.setCursorPosition(position) | [
"def",
"sort_kate_imports",
"(",
"add_imports",
"=",
"(",
")",
",",
"remove_imports",
"=",
"(",
")",
")",
":",
"document",
"=",
"kate",
".",
"activeDocument",
"(",
")",
"view",
"=",
"document",
".",
"activeView",
"(",
")",
"position",
"=",
"view",
".",
... | Sorts imports within Kate while maintaining cursor position and selection, even if length of file changes. | [
"Sorts",
"imports",
"within",
"Kate",
"while",
"maintaining",
"cursor",
"position",
"and",
"selection",
"even",
"if",
"length",
"of",
"file",
"changes",
"."
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/kate_plugin/isort_plugin.py#L37-L54 | train | 220,616 |
timothycrosley/isort | isort/isort.py | _SortImports._get_line | def _get_line(self) -> str:
"""Returns the current line from the file while incrementing the index."""
line = self.in_lines[self.index]
self.index += 1
return line | python | def _get_line(self) -> str:
"""Returns the current line from the file while incrementing the index."""
line = self.in_lines[self.index]
self.index += 1
return line | [
"def",
"_get_line",
"(",
"self",
")",
"->",
"str",
":",
"line",
"=",
"self",
".",
"in_lines",
"[",
"self",
".",
"index",
"]",
"self",
".",
"index",
"+=",
"1",
"return",
"line"
] | Returns the current line from the file while incrementing the index. | [
"Returns",
"the",
"current",
"line",
"from",
"the",
"file",
"while",
"incrementing",
"the",
"index",
"."
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/isort.py#L139-L143 | train | 220,617 |
timothycrosley/isort | isort/isort.py | _SortImports._add_comments | def _add_comments(
self,
comments: Optional[Sequence[str]],
original_string: str = ""
) -> str:
"""
Returns a string with comments added if ignore_comments is not set.
"""
if self.config['ignore_comments']:
return self._strip_comments(original_string)[0]
if not comments:
return original_string
else:
return "{0}{1} {2}".format(self._strip_comments(original_string)[0],
self.config['comment_prefix'],
"; ".join(comments)) | python | def _add_comments(
self,
comments: Optional[Sequence[str]],
original_string: str = ""
) -> str:
"""
Returns a string with comments added if ignore_comments is not set.
"""
if self.config['ignore_comments']:
return self._strip_comments(original_string)[0]
if not comments:
return original_string
else:
return "{0}{1} {2}".format(self._strip_comments(original_string)[0],
self.config['comment_prefix'],
"; ".join(comments)) | [
"def",
"_add_comments",
"(",
"self",
",",
"comments",
":",
"Optional",
"[",
"Sequence",
"[",
"str",
"]",
"]",
",",
"original_string",
":",
"str",
"=",
"\"\"",
")",
"->",
"str",
":",
"if",
"self",
".",
"config",
"[",
"'ignore_comments'",
"]",
":",
"retu... | Returns a string with comments added if ignore_comments is not set. | [
"Returns",
"a",
"string",
"with",
"comments",
"added",
"if",
"ignore_comments",
"is",
"not",
"set",
"."
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/isort.py#L194-L210 | train | 220,618 |
timothycrosley/isort | isort/isort.py | _SortImports._wrap | def _wrap(self, line: str) -> str:
"""
Returns an import wrapped to the specified line-length, if possible.
"""
wrap_mode = self.config['multi_line_output']
if len(line) > self.config['line_length'] and wrap_mode != WrapModes.NOQA:
line_without_comment = line
comment = None
if '#' in line:
line_without_comment, comment = line.split('#', 1)
for splitter in ("import ", ".", "as "):
exp = r"\b" + re.escape(splitter) + r"\b"
if re.search(exp, line_without_comment) and not line_without_comment.strip().startswith(splitter):
line_parts = re.split(exp, line_without_comment)
if comment:
line_parts[-1] = '{0}#{1}'.format(line_parts[-1], comment)
next_line = []
while (len(line) + 2) > (self.config['wrap_length'] or self.config['line_length']) and line_parts:
next_line.append(line_parts.pop())
line = splitter.join(line_parts)
if not line:
line = next_line.pop()
cont_line = self._wrap(self.config['indent'] + splitter.join(next_line).lstrip())
if self.config['use_parentheses']:
output = "{0}{1}({2}{3}{4}{5})".format(
line, splitter, self.line_separator, cont_line,
"," if self.config['include_trailing_comma'] else "",
self.line_separator if wrap_mode in {WrapModes.VERTICAL_HANGING_INDENT,
WrapModes.VERTICAL_GRID_GROUPED}
else "")
lines = output.split(self.line_separator)
if self.config['comment_prefix'] in lines[-1] and lines[-1].endswith(')'):
line, comment = lines[-1].split(self.config['comment_prefix'], 1)
lines[-1] = line + ')' + self.config['comment_prefix'] + comment[:-1]
return self.line_separator.join(lines)
return "{0}{1}\\{2}{3}".format(line, splitter, self.line_separator, cont_line)
elif len(line) > self.config['line_length'] and wrap_mode == settings.WrapModes.NOQA:
if "# NOQA" not in line:
return "{0}{1} NOQA".format(line, self.config['comment_prefix'])
return line | python | def _wrap(self, line: str) -> str:
"""
Returns an import wrapped to the specified line-length, if possible.
"""
wrap_mode = self.config['multi_line_output']
if len(line) > self.config['line_length'] and wrap_mode != WrapModes.NOQA:
line_without_comment = line
comment = None
if '#' in line:
line_without_comment, comment = line.split('#', 1)
for splitter in ("import ", ".", "as "):
exp = r"\b" + re.escape(splitter) + r"\b"
if re.search(exp, line_without_comment) and not line_without_comment.strip().startswith(splitter):
line_parts = re.split(exp, line_without_comment)
if comment:
line_parts[-1] = '{0}#{1}'.format(line_parts[-1], comment)
next_line = []
while (len(line) + 2) > (self.config['wrap_length'] or self.config['line_length']) and line_parts:
next_line.append(line_parts.pop())
line = splitter.join(line_parts)
if not line:
line = next_line.pop()
cont_line = self._wrap(self.config['indent'] + splitter.join(next_line).lstrip())
if self.config['use_parentheses']:
output = "{0}{1}({2}{3}{4}{5})".format(
line, splitter, self.line_separator, cont_line,
"," if self.config['include_trailing_comma'] else "",
self.line_separator if wrap_mode in {WrapModes.VERTICAL_HANGING_INDENT,
WrapModes.VERTICAL_GRID_GROUPED}
else "")
lines = output.split(self.line_separator)
if self.config['comment_prefix'] in lines[-1] and lines[-1].endswith(')'):
line, comment = lines[-1].split(self.config['comment_prefix'], 1)
lines[-1] = line + ')' + self.config['comment_prefix'] + comment[:-1]
return self.line_separator.join(lines)
return "{0}{1}\\{2}{3}".format(line, splitter, self.line_separator, cont_line)
elif len(line) > self.config['line_length'] and wrap_mode == settings.WrapModes.NOQA:
if "# NOQA" not in line:
return "{0}{1} NOQA".format(line, self.config['comment_prefix'])
return line | [
"def",
"_wrap",
"(",
"self",
",",
"line",
":",
"str",
")",
"->",
"str",
":",
"wrap_mode",
"=",
"self",
".",
"config",
"[",
"'multi_line_output'",
"]",
"if",
"len",
"(",
"line",
")",
">",
"self",
".",
"config",
"[",
"'line_length'",
"]",
"and",
"wrap_... | Returns an import wrapped to the specified line-length, if possible. | [
"Returns",
"an",
"import",
"wrapped",
"to",
"the",
"specified",
"line",
"-",
"length",
"if",
"possible",
"."
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/isort.py#L212-L253 | train | 220,619 |
timothycrosley/isort | isort/finders.py | KnownPatternFinder._parse_known_pattern | def _parse_known_pattern(self, pattern: str) -> List[str]:
"""
Expand pattern if identified as a directory and return found sub packages
"""
if pattern.endswith(os.path.sep):
patterns = [
filename
for filename in os.listdir(pattern)
if os.path.isdir(os.path.join(pattern, filename))
]
else:
patterns = [pattern]
return patterns | python | def _parse_known_pattern(self, pattern: str) -> List[str]:
"""
Expand pattern if identified as a directory and return found sub packages
"""
if pattern.endswith(os.path.sep):
patterns = [
filename
for filename in os.listdir(pattern)
if os.path.isdir(os.path.join(pattern, filename))
]
else:
patterns = [pattern]
return patterns | [
"def",
"_parse_known_pattern",
"(",
"self",
",",
"pattern",
":",
"str",
")",
"->",
"List",
"[",
"str",
"]",
":",
"if",
"pattern",
".",
"endswith",
"(",
"os",
".",
"path",
".",
"sep",
")",
":",
"patterns",
"=",
"[",
"filename",
"for",
"filename",
"in"... | Expand pattern if identified as a directory and return found sub packages | [
"Expand",
"pattern",
"if",
"identified",
"as",
"a",
"directory",
"and",
"return",
"found",
"sub",
"packages"
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/finders.py#L86-L99 | train | 220,620 |
timothycrosley/isort | isort/finders.py | ReqsBaseFinder._load_mapping | def _load_mapping() -> Optional[Dict[str, str]]:
"""Return list of mappings `package_name -> module_name`
Example:
django-haystack -> haystack
"""
if not pipreqs:
return None
path = os.path.dirname(inspect.getfile(pipreqs))
path = os.path.join(path, 'mapping')
with open(path) as f:
# pypi_name: import_name
mappings = {} # type: Dict[str, str]
for line in f:
import_name, _, pypi_name = line.strip().partition(":")
mappings[pypi_name] = import_name
return mappings | python | def _load_mapping() -> Optional[Dict[str, str]]:
"""Return list of mappings `package_name -> module_name`
Example:
django-haystack -> haystack
"""
if not pipreqs:
return None
path = os.path.dirname(inspect.getfile(pipreqs))
path = os.path.join(path, 'mapping')
with open(path) as f:
# pypi_name: import_name
mappings = {} # type: Dict[str, str]
for line in f:
import_name, _, pypi_name = line.strip().partition(":")
mappings[pypi_name] = import_name
return mappings | [
"def",
"_load_mapping",
"(",
")",
"->",
"Optional",
"[",
"Dict",
"[",
"str",
",",
"str",
"]",
"]",
":",
"if",
"not",
"pipreqs",
":",
"return",
"None",
"path",
"=",
"os",
".",
"path",
".",
"dirname",
"(",
"inspect",
".",
"getfile",
"(",
"pipreqs",
"... | Return list of mappings `package_name -> module_name`
Example:
django-haystack -> haystack | [
"Return",
"list",
"of",
"mappings",
"package_name",
"-",
">",
"module_name"
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/finders.py#L200-L216 | train | 220,621 |
timothycrosley/isort | isort/finders.py | ReqsBaseFinder._load_names | def _load_names(self) -> List[str]:
"""Return list of thirdparty modules from requirements
"""
names = []
for path in self._get_files():
for name in self._get_names(path):
names.append(self._normalize_name(name))
return names | python | def _load_names(self) -> List[str]:
"""Return list of thirdparty modules from requirements
"""
names = []
for path in self._get_files():
for name in self._get_names(path):
names.append(self._normalize_name(name))
return names | [
"def",
"_load_names",
"(",
"self",
")",
"->",
"List",
"[",
"str",
"]",
":",
"names",
"=",
"[",
"]",
"for",
"path",
"in",
"self",
".",
"_get_files",
"(",
")",
":",
"for",
"name",
"in",
"self",
".",
"_get_names",
"(",
"path",
")",
":",
"names",
"."... | Return list of thirdparty modules from requirements | [
"Return",
"list",
"of",
"thirdparty",
"modules",
"from",
"requirements"
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/finders.py#L219-L226 | train | 220,622 |
timothycrosley/isort | isort/finders.py | ReqsBaseFinder._get_files | def _get_files(self) -> Iterator[str]:
"""Return paths to all requirements files
"""
path = os.path.abspath(self.path)
if os.path.isfile(path):
path = os.path.dirname(path)
for path in self._get_parents(path):
for file_path in self._get_files_from_dir(path):
yield file_path | python | def _get_files(self) -> Iterator[str]:
"""Return paths to all requirements files
"""
path = os.path.abspath(self.path)
if os.path.isfile(path):
path = os.path.dirname(path)
for path in self._get_parents(path):
for file_path in self._get_files_from_dir(path):
yield file_path | [
"def",
"_get_files",
"(",
"self",
")",
"->",
"Iterator",
"[",
"str",
"]",
":",
"path",
"=",
"os",
".",
"path",
".",
"abspath",
"(",
"self",
".",
"path",
")",
"if",
"os",
".",
"path",
".",
"isfile",
"(",
"path",
")",
":",
"path",
"=",
"os",
".",... | Return paths to all requirements files | [
"Return",
"paths",
"to",
"all",
"requirements",
"files"
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/finders.py#L236-L245 | train | 220,623 |
timothycrosley/isort | isort/finders.py | ReqsBaseFinder._normalize_name | def _normalize_name(self, name: str) -> str:
"""Convert package name to module name
Examples:
Django -> django
django-haystack -> django_haystack
Flask-RESTFul -> flask_restful
"""
if self.mapping:
name = self.mapping.get(name, name)
return name.lower().replace('-', '_') | python | def _normalize_name(self, name: str) -> str:
"""Convert package name to module name
Examples:
Django -> django
django-haystack -> django_haystack
Flask-RESTFul -> flask_restful
"""
if self.mapping:
name = self.mapping.get(name, name)
return name.lower().replace('-', '_') | [
"def",
"_normalize_name",
"(",
"self",
",",
"name",
":",
"str",
")",
"->",
"str",
":",
"if",
"self",
".",
"mapping",
":",
"name",
"=",
"self",
".",
"mapping",
".",
"get",
"(",
"name",
",",
"name",
")",
"return",
"name",
".",
"lower",
"(",
")",
".... | Convert package name to module name
Examples:
Django -> django
django-haystack -> django_haystack
Flask-RESTFul -> flask_restful | [
"Convert",
"package",
"name",
"to",
"module",
"name"
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/finders.py#L247-L257 | train | 220,624 |
timothycrosley/isort | isort/finders.py | RequirementsFinder._get_names | def _get_names(self, path: str) -> Iterator[str]:
"""Load required packages from path to requirements file
"""
for i in RequirementsFinder._get_names_cached(path):
yield i | python | def _get_names(self, path: str) -> Iterator[str]:
"""Load required packages from path to requirements file
"""
for i in RequirementsFinder._get_names_cached(path):
yield i | [
"def",
"_get_names",
"(",
"self",
",",
"path",
":",
"str",
")",
"->",
"Iterator",
"[",
"str",
"]",
":",
"for",
"i",
"in",
"RequirementsFinder",
".",
"_get_names_cached",
"(",
"path",
")",
":",
"yield",
"i"
] | Load required packages from path to requirements file | [
"Load",
"required",
"packages",
"from",
"path",
"to",
"requirements",
"file"
] | 493c02a1a000fe782cec56f1f43262bacb316381 | https://github.com/timothycrosley/isort/blob/493c02a1a000fe782cec56f1f43262bacb316381/isort/finders.py#L310-L314 | train | 220,625 |
graphql-python/graphql-ws | graphql_ws/django_channels.py | GraphQLSubscriptionConsumer.receive | def receive(self, content, **kwargs):
"""
Called when a message is received with either text or bytes
filled out.
"""
self.connection_context = DjangoChannelConnectionContext(self.message)
self.subscription_server = DjangoChannelSubscriptionServer(graphene_settings.SCHEMA)
self.subscription_server.on_open(self.connection_context)
self.subscription_server.handle(content, self.connection_context) | python | def receive(self, content, **kwargs):
"""
Called when a message is received with either text or bytes
filled out.
"""
self.connection_context = DjangoChannelConnectionContext(self.message)
self.subscription_server = DjangoChannelSubscriptionServer(graphene_settings.SCHEMA)
self.subscription_server.on_open(self.connection_context)
self.subscription_server.handle(content, self.connection_context) | [
"def",
"receive",
"(",
"self",
",",
"content",
",",
"*",
"*",
"kwargs",
")",
":",
"self",
".",
"connection_context",
"=",
"DjangoChannelConnectionContext",
"(",
"self",
".",
"message",
")",
"self",
".",
"subscription_server",
"=",
"DjangoChannelSubscriptionServer"... | Called when a message is received with either text or bytes
filled out. | [
"Called",
"when",
"a",
"message",
"is",
"received",
"with",
"either",
"text",
"or",
"bytes",
"filled",
"out",
"."
] | 523dd1516d8709149a475602042d6a3c5eab5a3d | https://github.com/graphql-python/graphql-ws/blob/523dd1516d8709149a475602042d6a3c5eab5a3d/graphql_ws/django_channels.py#L106-L114 | train | 220,626 |
autokey/autokey | lib/autokey/qtui/settings/general.py | GeneralSettings.save | def save(self):
"""Called by the parent settings dialog when the user clicks on the Save button.
Stores the current settings in the ConfigManager."""
logger.debug("User requested to save settings. New settings: " + self._settings_str())
cm.ConfigManager.SETTINGS[cm.PROMPT_TO_SAVE] = not self.autosave_checkbox.isChecked()
cm.ConfigManager.SETTINGS[cm.SHOW_TRAY_ICON] = self.show_tray_checkbox.isChecked()
# cm.ConfigManager.SETTINGS[cm.MENU_TAKES_FOCUS] = self.allow_kb_nav_checkbox.isChecked()
cm.ConfigManager.SETTINGS[cm.SORT_BY_USAGE_COUNT] = self.sort_by_usage_checkbox.isChecked()
cm.ConfigManager.SETTINGS[cm.UNDO_USING_BACKSPACE] = self.enable_undo_checkbox.isChecked()
cm.ConfigManager.SETTINGS[cm.NOTIFICATION_ICON] = self.system_tray_icon_theme_combobox.currentData(Qt.UserRole)
# TODO: After saving the notification icon, apply it to the currently running instance.
self._save_autostart_settings() | python | def save(self):
"""Called by the parent settings dialog when the user clicks on the Save button.
Stores the current settings in the ConfigManager."""
logger.debug("User requested to save settings. New settings: " + self._settings_str())
cm.ConfigManager.SETTINGS[cm.PROMPT_TO_SAVE] = not self.autosave_checkbox.isChecked()
cm.ConfigManager.SETTINGS[cm.SHOW_TRAY_ICON] = self.show_tray_checkbox.isChecked()
# cm.ConfigManager.SETTINGS[cm.MENU_TAKES_FOCUS] = self.allow_kb_nav_checkbox.isChecked()
cm.ConfigManager.SETTINGS[cm.SORT_BY_USAGE_COUNT] = self.sort_by_usage_checkbox.isChecked()
cm.ConfigManager.SETTINGS[cm.UNDO_USING_BACKSPACE] = self.enable_undo_checkbox.isChecked()
cm.ConfigManager.SETTINGS[cm.NOTIFICATION_ICON] = self.system_tray_icon_theme_combobox.currentData(Qt.UserRole)
# TODO: After saving the notification icon, apply it to the currently running instance.
self._save_autostart_settings() | [
"def",
"save",
"(",
"self",
")",
":",
"logger",
".",
"debug",
"(",
"\"User requested to save settings. New settings: \"",
"+",
"self",
".",
"_settings_str",
"(",
")",
")",
"cm",
".",
"ConfigManager",
".",
"SETTINGS",
"[",
"cm",
".",
"PROMPT_TO_SAVE",
"]",
"=",... | Called by the parent settings dialog when the user clicks on the Save button.
Stores the current settings in the ConfigManager. | [
"Called",
"by",
"the",
"parent",
"settings",
"dialog",
"when",
"the",
"user",
"clicks",
"on",
"the",
"Save",
"button",
".",
"Stores",
"the",
"current",
"settings",
"in",
"the",
"ConfigManager",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/settings/general.py#L59-L70 | train | 220,627 |
autokey/autokey | lib/autokey/qtui/settings/general.py | GeneralSettings._settings_str | def _settings_str(self):
"""Returns a human readable settings representation for logging purposes."""
settings = "Automatically save changes: {}, " \
"Show tray icon: {}, " \
"Allow keyboard navigation: {}, " \
"Sort by usage count: {}, " \
"Enable undo using backspace: {}, " \
"Tray icon theme: {}".format(
self.autosave_checkbox.isChecked(),
self.show_tray_checkbox.isChecked(),
self.allow_kb_nav_checkbox.isChecked(),
self.sort_by_usage_checkbox.isChecked(),
self.enable_undo_checkbox.isChecked(),
self.system_tray_icon_theme_combobox.currentData(Qt.UserRole)
)
return settings | python | def _settings_str(self):
"""Returns a human readable settings representation for logging purposes."""
settings = "Automatically save changes: {}, " \
"Show tray icon: {}, " \
"Allow keyboard navigation: {}, " \
"Sort by usage count: {}, " \
"Enable undo using backspace: {}, " \
"Tray icon theme: {}".format(
self.autosave_checkbox.isChecked(),
self.show_tray_checkbox.isChecked(),
self.allow_kb_nav_checkbox.isChecked(),
self.sort_by_usage_checkbox.isChecked(),
self.enable_undo_checkbox.isChecked(),
self.system_tray_icon_theme_combobox.currentData(Qt.UserRole)
)
return settings | [
"def",
"_settings_str",
"(",
"self",
")",
":",
"settings",
"=",
"\"Automatically save changes: {}, \"",
"\"Show tray icon: {}, \"",
"\"Allow keyboard navigation: {}, \"",
"\"Sort by usage count: {}, \"",
"\"Enable undo using backspace: {}, \"",
"\"Tray icon theme: {}\"",
".",
"format",... | Returns a human readable settings representation for logging purposes. | [
"Returns",
"a",
"human",
"readable",
"settings",
"representation",
"for",
"logging",
"purposes",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/settings/general.py#L72-L87 | train | 220,628 |
autokey/autokey | lib/autokey/model.py | AbstractAbbreviation._should_trigger_abbreviation | def _should_trigger_abbreviation(self, buffer):
"""
Checks whether, based on the settings for the abbreviation and the given input,
the abbreviation should trigger.
@param buffer Input buffer to be checked (as string)
"""
return any(self.__checkInput(buffer, abbr) for abbr in self.abbreviations) | python | def _should_trigger_abbreviation(self, buffer):
"""
Checks whether, based on the settings for the abbreviation and the given input,
the abbreviation should trigger.
@param buffer Input buffer to be checked (as string)
"""
return any(self.__checkInput(buffer, abbr) for abbr in self.abbreviations) | [
"def",
"_should_trigger_abbreviation",
"(",
"self",
",",
"buffer",
")",
":",
"return",
"any",
"(",
"self",
".",
"__checkInput",
"(",
"buffer",
",",
"abbr",
")",
"for",
"abbr",
"in",
"self",
".",
"abbreviations",
")"
] | Checks whether, based on the settings for the abbreviation and the given input,
the abbreviation should trigger.
@param buffer Input buffer to be checked (as string) | [
"Checks",
"whether",
"based",
"on",
"the",
"settings",
"for",
"the",
"abbreviation",
"and",
"the",
"given",
"input",
"the",
"abbreviation",
"should",
"trigger",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/model.py#L175-L182 | train | 220,629 |
autokey/autokey | lib/autokey/model.py | AbstractWindowFilter.get_filter_regex | def get_filter_regex(self):
"""
Used by the GUI to obtain human-readable version of the filter
"""
if self.windowInfoRegex is not None:
if self.isRecursive:
return self.windowInfoRegex.pattern
else:
return self.windowInfoRegex.pattern
elif self.parent is not None:
return self.parent.get_child_filter()
else:
return "" | python | def get_filter_regex(self):
"""
Used by the GUI to obtain human-readable version of the filter
"""
if self.windowInfoRegex is not None:
if self.isRecursive:
return self.windowInfoRegex.pattern
else:
return self.windowInfoRegex.pattern
elif self.parent is not None:
return self.parent.get_child_filter()
else:
return "" | [
"def",
"get_filter_regex",
"(",
"self",
")",
":",
"if",
"self",
".",
"windowInfoRegex",
"is",
"not",
"None",
":",
"if",
"self",
".",
"isRecursive",
":",
"return",
"self",
".",
"windowInfoRegex",
".",
"pattern",
"else",
":",
"return",
"self",
".",
"windowIn... | Used by the GUI to obtain human-readable version of the filter | [
"Used",
"by",
"the",
"GUI",
"to",
"obtain",
"human",
"-",
"readable",
"version",
"of",
"the",
"filter"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/model.py#L313-L325 | train | 220,630 |
autokey/autokey | lib/autokey/model.py | Folder.add_item | def add_item(self, item):
"""
Add a new script or phrase to the folder.
"""
item.parent = self
#self.phrases[phrase.description] = phrase
self.items.append(item) | python | def add_item(self, item):
"""
Add a new script or phrase to the folder.
"""
item.parent = self
#self.phrases[phrase.description] = phrase
self.items.append(item) | [
"def",
"add_item",
"(",
"self",
",",
"item",
")",
":",
"item",
".",
"parent",
"=",
"self",
"#self.phrases[phrase.description] = phrase",
"self",
".",
"items",
".",
"append",
"(",
"item",
")"
] | Add a new script or phrase to the folder. | [
"Add",
"a",
"new",
"script",
"or",
"phrase",
"to",
"the",
"folder",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/model.py#L546-L552 | train | 220,631 |
autokey/autokey | lib/autokey/model.py | Folder.get_backspace_count | def get_backspace_count(self, buffer):
"""
Given the input buffer, calculate how many backspaces are needed to erase the text
that triggered this folder.
"""
if TriggerMode.ABBREVIATION in self.modes and self.backspace:
if self._should_trigger_abbreviation(buffer):
abbr = self._get_trigger_abbreviation(buffer)
stringBefore, typedAbbr, stringAfter = self._partition_input(buffer, abbr)
return len(abbr) + len(stringAfter)
if self.parent is not None:
return self.parent.get_backspace_count(buffer)
return 0 | python | def get_backspace_count(self, buffer):
"""
Given the input buffer, calculate how many backspaces are needed to erase the text
that triggered this folder.
"""
if TriggerMode.ABBREVIATION in self.modes and self.backspace:
if self._should_trigger_abbreviation(buffer):
abbr = self._get_trigger_abbreviation(buffer)
stringBefore, typedAbbr, stringAfter = self._partition_input(buffer, abbr)
return len(abbr) + len(stringAfter)
if self.parent is not None:
return self.parent.get_backspace_count(buffer)
return 0 | [
"def",
"get_backspace_count",
"(",
"self",
",",
"buffer",
")",
":",
"if",
"TriggerMode",
".",
"ABBREVIATION",
"in",
"self",
".",
"modes",
"and",
"self",
".",
"backspace",
":",
"if",
"self",
".",
"_should_trigger_abbreviation",
"(",
"buffer",
")",
":",
"abbr"... | Given the input buffer, calculate how many backspaces are needed to erase the text
that triggered this folder. | [
"Given",
"the",
"input",
"buffer",
"calculate",
"how",
"many",
"backspaces",
"are",
"needed",
"to",
"erase",
"the",
"text",
"that",
"triggered",
"this",
"folder",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/model.py#L572-L586 | train | 220,632 |
autokey/autokey | lib/autokey/model.py | Phrase.calculate_input | def calculate_input(self, buffer):
"""
Calculate how many keystrokes were used in triggering this phrase.
"""
# TODO: This function is unused?
if TriggerMode.ABBREVIATION in self.modes:
if self._should_trigger_abbreviation(buffer):
if self.immediate:
return len(self._get_trigger_abbreviation(buffer))
else:
return len(self._get_trigger_abbreviation(buffer)) + 1
# TODO - re-enable me if restoring predictive functionality
#if TriggerMode.PREDICTIVE in self.modes:
# if self._should_trigger_predictive(buffer):
# return ConfigManager.SETTINGS[PREDICTIVE_LENGTH]
if TriggerMode.HOTKEY in self.modes:
if buffer == '':
return len(self.modifiers) + 1
return self.parent.calculate_input(buffer) | python | def calculate_input(self, buffer):
"""
Calculate how many keystrokes were used in triggering this phrase.
"""
# TODO: This function is unused?
if TriggerMode.ABBREVIATION in self.modes:
if self._should_trigger_abbreviation(buffer):
if self.immediate:
return len(self._get_trigger_abbreviation(buffer))
else:
return len(self._get_trigger_abbreviation(buffer)) + 1
# TODO - re-enable me if restoring predictive functionality
#if TriggerMode.PREDICTIVE in self.modes:
# if self._should_trigger_predictive(buffer):
# return ConfigManager.SETTINGS[PREDICTIVE_LENGTH]
if TriggerMode.HOTKEY in self.modes:
if buffer == '':
return len(self.modifiers) + 1
return self.parent.calculate_input(buffer) | [
"def",
"calculate_input",
"(",
"self",
",",
"buffer",
")",
":",
"# TODO: This function is unused?",
"if",
"TriggerMode",
".",
"ABBREVIATION",
"in",
"self",
".",
"modes",
":",
"if",
"self",
".",
"_should_trigger_abbreviation",
"(",
"buffer",
")",
":",
"if",
"self... | Calculate how many keystrokes were used in triggering this phrase. | [
"Calculate",
"how",
"many",
"keystrokes",
"were",
"used",
"in",
"triggering",
"this",
"phrase",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/model.py#L797-L818 | train | 220,633 |
autokey/autokey | lib/autokey/model.py | Script._persist_metadata | def _persist_metadata(self):
"""
Write all script meta-data, including the persistent script Store.
The Store instance might contain arbitrary user data, like function objects, OpenCL contexts, or whatever other
non-serializable objects, both as keys or values.
Try to serialize the data, and if it fails, fall back to checking the store and removing all non-serializable
data.
"""
serializable_data = self.get_serializable()
try:
self._try_persist_metadata(serializable_data)
except TypeError:
# The user added non-serializable data to the store, so skip all non-serializable keys or values.
cleaned_data = Script._remove_non_serializable_store_entries(serializable_data["store"])
self._try_persist_metadata(cleaned_data) | python | def _persist_metadata(self):
"""
Write all script meta-data, including the persistent script Store.
The Store instance might contain arbitrary user data, like function objects, OpenCL contexts, or whatever other
non-serializable objects, both as keys or values.
Try to serialize the data, and if it fails, fall back to checking the store and removing all non-serializable
data.
"""
serializable_data = self.get_serializable()
try:
self._try_persist_metadata(serializable_data)
except TypeError:
# The user added non-serializable data to the store, so skip all non-serializable keys or values.
cleaned_data = Script._remove_non_serializable_store_entries(serializable_data["store"])
self._try_persist_metadata(cleaned_data) | [
"def",
"_persist_metadata",
"(",
"self",
")",
":",
"serializable_data",
"=",
"self",
".",
"get_serializable",
"(",
")",
"try",
":",
"self",
".",
"_try_persist_metadata",
"(",
"serializable_data",
")",
"except",
"TypeError",
":",
"# The user added non-serializable data... | Write all script meta-data, including the persistent script Store.
The Store instance might contain arbitrary user data, like function objects, OpenCL contexts, or whatever other
non-serializable objects, both as keys or values.
Try to serialize the data, and if it fails, fall back to checking the store and removing all non-serializable
data. | [
"Write",
"all",
"script",
"meta",
"-",
"data",
"including",
"the",
"persistent",
"script",
"Store",
".",
"The",
"Store",
"instance",
"might",
"contain",
"arbitrary",
"user",
"data",
"like",
"function",
"objects",
"OpenCL",
"contexts",
"or",
"whatever",
"other",
... | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/model.py#L949-L963 | train | 220,634 |
autokey/autokey | lib/autokey/model.py | Script._remove_non_serializable_store_entries | def _remove_non_serializable_store_entries(store: Store) -> dict:
"""
Copy all serializable data into a new dict, and skip the rest.
This makes sure to keep the items during runtime, even if the user edits and saves the script.
"""
cleaned_store_data = {}
for key, value in store.items():
if Script._is_serializable(key) and Script._is_serializable(value):
cleaned_store_data[key] = value
else:
_logger.info("Skip non-serializable item in the local script store. Key: '{}', Value: '{}'. "
"This item cannot be saved and therefore will be lost when autokey quits.".format(
key, value
))
return cleaned_store_data | python | def _remove_non_serializable_store_entries(store: Store) -> dict:
"""
Copy all serializable data into a new dict, and skip the rest.
This makes sure to keep the items during runtime, even if the user edits and saves the script.
"""
cleaned_store_data = {}
for key, value in store.items():
if Script._is_serializable(key) and Script._is_serializable(value):
cleaned_store_data[key] = value
else:
_logger.info("Skip non-serializable item in the local script store. Key: '{}', Value: '{}'. "
"This item cannot be saved and therefore will be lost when autokey quits.".format(
key, value
))
return cleaned_store_data | [
"def",
"_remove_non_serializable_store_entries",
"(",
"store",
":",
"Store",
")",
"->",
"dict",
":",
"cleaned_store_data",
"=",
"{",
"}",
"for",
"key",
",",
"value",
"in",
"store",
".",
"items",
"(",
")",
":",
"if",
"Script",
".",
"_is_serializable",
"(",
... | Copy all serializable data into a new dict, and skip the rest.
This makes sure to keep the items during runtime, even if the user edits and saves the script. | [
"Copy",
"all",
"serializable",
"data",
"into",
"a",
"new",
"dict",
"and",
"skip",
"the",
"rest",
".",
"This",
"makes",
"sure",
"to",
"keep",
"the",
"items",
"during",
"runtime",
"even",
"if",
"the",
"user",
"edits",
"and",
"saves",
"the",
"script",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/model.py#L970-L984 | train | 220,635 |
autokey/autokey | lib/autokey/qtapp.py | Application._configure_root_logger | def _configure_root_logger(self):
"""Initialise logging system"""
root_logger = logging.getLogger()
root_logger.setLevel(logging.DEBUG)
if self.args.verbose:
handler = logging.StreamHandler(sys.stdout)
else:
handler = logging.handlers.RotatingFileHandler(
common.LOG_FILE,
maxBytes=common.MAX_LOG_SIZE,
backupCount=common.MAX_LOG_COUNT
)
handler.setLevel(logging.INFO)
handler.setFormatter(logging.Formatter(common.LOG_FORMAT))
root_logger.addHandler(handler) | python | def _configure_root_logger(self):
"""Initialise logging system"""
root_logger = logging.getLogger()
root_logger.setLevel(logging.DEBUG)
if self.args.verbose:
handler = logging.StreamHandler(sys.stdout)
else:
handler = logging.handlers.RotatingFileHandler(
common.LOG_FILE,
maxBytes=common.MAX_LOG_SIZE,
backupCount=common.MAX_LOG_COUNT
)
handler.setLevel(logging.INFO)
handler.setFormatter(logging.Formatter(common.LOG_FORMAT))
root_logger.addHandler(handler) | [
"def",
"_configure_root_logger",
"(",
"self",
")",
":",
"root_logger",
"=",
"logging",
".",
"getLogger",
"(",
")",
"root_logger",
".",
"setLevel",
"(",
"logging",
".",
"DEBUG",
")",
"if",
"self",
".",
"args",
".",
"verbose",
":",
"handler",
"=",
"logging",... | Initialise logging system | [
"Initialise",
"logging",
"system"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtapp.py#L165-L179 | train | 220,636 |
autokey/autokey | lib/autokey/qtapp.py | Application._create_storage_directories | def _create_storage_directories():
"""Create various storage directories, if those do not exist."""
# Create configuration directory
if not os.path.exists(common.CONFIG_DIR):
os.makedirs(common.CONFIG_DIR)
# Create data directory (for log file)
if not os.path.exists(common.DATA_DIR):
os.makedirs(common.DATA_DIR)
# Create run directory (for lock file)
if not os.path.exists(common.RUN_DIR):
os.makedirs(common.RUN_DIR) | python | def _create_storage_directories():
"""Create various storage directories, if those do not exist."""
# Create configuration directory
if not os.path.exists(common.CONFIG_DIR):
os.makedirs(common.CONFIG_DIR)
# Create data directory (for log file)
if not os.path.exists(common.DATA_DIR):
os.makedirs(common.DATA_DIR)
# Create run directory (for lock file)
if not os.path.exists(common.RUN_DIR):
os.makedirs(common.RUN_DIR) | [
"def",
"_create_storage_directories",
"(",
")",
":",
"# Create configuration directory",
"if",
"not",
"os",
".",
"path",
".",
"exists",
"(",
"common",
".",
"CONFIG_DIR",
")",
":",
"os",
".",
"makedirs",
"(",
"common",
".",
"CONFIG_DIR",
")",
"# Create data direc... | Create various storage directories, if those do not exist. | [
"Create",
"various",
"storage",
"directories",
"if",
"those",
"do",
"not",
"exist",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtapp.py#L182-L192 | train | 220,637 |
autokey/autokey | lib/autokey/qtapp.py | Application.toggle_service | def toggle_service(self):
"""
Convenience method for toggling the expansion service on or off. This is called by the global hotkey.
"""
self.monitoring_disabled.emit(not self.service.is_running())
if self.service.is_running():
self.pause_service()
else:
self.unpause_service() | python | def toggle_service(self):
"""
Convenience method for toggling the expansion service on or off. This is called by the global hotkey.
"""
self.monitoring_disabled.emit(not self.service.is_running())
if self.service.is_running():
self.pause_service()
else:
self.unpause_service() | [
"def",
"toggle_service",
"(",
"self",
")",
":",
"self",
".",
"monitoring_disabled",
".",
"emit",
"(",
"not",
"self",
".",
"service",
".",
"is_running",
"(",
")",
")",
"if",
"self",
".",
"service",
".",
"is_running",
"(",
")",
":",
"self",
".",
"pause_s... | Convenience method for toggling the expansion service on or off. This is called by the global hotkey. | [
"Convenience",
"method",
"for",
"toggling",
"the",
"expansion",
"service",
"on",
"or",
"off",
".",
"This",
"is",
"called",
"by",
"the",
"global",
"hotkey",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtapp.py#L271-L279 | train | 220,638 |
autokey/autokey | lib/autokey/qtui/notifier.py | Notifier.create_assign_context_menu | def create_assign_context_menu(self):
"""
Create a context menu, then set the created QMenu as the context menu.
This builds the menu with all required actions and signal-slot connections.
"""
menu = QMenu("AutoKey")
self._build_menu(menu)
self.setContextMenu(menu) | python | def create_assign_context_menu(self):
"""
Create a context menu, then set the created QMenu as the context menu.
This builds the menu with all required actions and signal-slot connections.
"""
menu = QMenu("AutoKey")
self._build_menu(menu)
self.setContextMenu(menu) | [
"def",
"create_assign_context_menu",
"(",
"self",
")",
":",
"menu",
"=",
"QMenu",
"(",
"\"AutoKey\"",
")",
"self",
".",
"_build_menu",
"(",
"menu",
")",
"self",
".",
"setContextMenu",
"(",
"menu",
")"
] | Create a context menu, then set the created QMenu as the context menu.
This builds the menu with all required actions and signal-slot connections. | [
"Create",
"a",
"context",
"menu",
"then",
"set",
"the",
"created",
"QMenu",
"as",
"the",
"context",
"menu",
".",
"This",
"builds",
"the",
"menu",
"with",
"all",
"required",
"actions",
"and",
"signal",
"-",
"slot",
"connections",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/notifier.py#L62-L69 | train | 220,639 |
autokey/autokey | lib/autokey/qtui/notifier.py | Notifier.update_tool_tip | def update_tool_tip(self, service_running: bool):
"""Slot function that updates the tooltip when the user activates or deactivates the expansion service."""
if service_running:
self.setToolTip(TOOLTIP_RUNNING)
else:
self.setToolTip(TOOLTIP_PAUSED) | python | def update_tool_tip(self, service_running: bool):
"""Slot function that updates the tooltip when the user activates or deactivates the expansion service."""
if service_running:
self.setToolTip(TOOLTIP_RUNNING)
else:
self.setToolTip(TOOLTIP_PAUSED) | [
"def",
"update_tool_tip",
"(",
"self",
",",
"service_running",
":",
"bool",
")",
":",
"if",
"service_running",
":",
"self",
".",
"setToolTip",
"(",
"TOOLTIP_RUNNING",
")",
"else",
":",
"self",
".",
"setToolTip",
"(",
"TOOLTIP_PAUSED",
")"
] | Slot function that updates the tooltip when the user activates or deactivates the expansion service. | [
"Slot",
"function",
"that",
"updates",
"the",
"tooltip",
"when",
"the",
"user",
"activates",
"or",
"deactivates",
"the",
"expansion",
"service",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/notifier.py#L71-L76 | train | 220,640 |
autokey/autokey | lib/autokey/qtui/notifier.py | Notifier._create_action | def _create_action(
self,
icon_name: Optional[str],
title: str,
slot_function: Callable[[None], None],
tool_tip: Optional[str]=None)-> QAction:
"""
QAction factory. All items created belong to the calling instance, i.e. created QAction parent is self.
"""
action = QAction(title, self)
if icon_name:
action.setIcon(QIcon.fromTheme(icon_name))
action.triggered.connect(slot_function)
if tool_tip:
action.setToolTip(tool_tip)
return action | python | def _create_action(
self,
icon_name: Optional[str],
title: str,
slot_function: Callable[[None], None],
tool_tip: Optional[str]=None)-> QAction:
"""
QAction factory. All items created belong to the calling instance, i.e. created QAction parent is self.
"""
action = QAction(title, self)
if icon_name:
action.setIcon(QIcon.fromTheme(icon_name))
action.triggered.connect(slot_function)
if tool_tip:
action.setToolTip(tool_tip)
return action | [
"def",
"_create_action",
"(",
"self",
",",
"icon_name",
":",
"Optional",
"[",
"str",
"]",
",",
"title",
":",
"str",
",",
"slot_function",
":",
"Callable",
"[",
"[",
"None",
"]",
",",
"None",
"]",
",",
"tool_tip",
":",
"Optional",
"[",
"str",
"]",
"="... | QAction factory. All items created belong to the calling instance, i.e. created QAction parent is self. | [
"QAction",
"factory",
".",
"All",
"items",
"created",
"belong",
"to",
"the",
"calling",
"instance",
"i",
".",
"e",
".",
"created",
"QAction",
"parent",
"is",
"self",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/notifier.py#L92-L107 | train | 220,641 |
autokey/autokey | lib/autokey/qtui/notifier.py | Notifier._create_static_actions | def _create_static_actions(self):
"""
Create all static menu actions. The created actions will be placed in the tray icon context menu.
"""
logger.info("Creating static context menu actions.")
self.action_view_script_error = self._create_action(
None, "&View script error", self.reset_tray_icon,
"View the last script error."
)
self.action_view_script_error.triggered.connect(self.app.show_script_error)
# The action should disable itself
self.action_view_script_error.setDisabled(True)
self.action_view_script_error.triggered.connect(self.action_view_script_error.setEnabled)
self.action_hide_icon = self._create_action(
"edit-clear", "Temporarily &Hide Icon", self.hide,
"Temporarily hide the system tray icon.\nUse the settings to hide it permanently."
)
self.action_show_config_window = self._create_action(
"configure", "&Show Main Window", self.app.show_configure,
"Show the main AutoKey window. This does the same as left clicking the tray icon."
)
self.action_quit = self._create_action("application-exit", "Exit AutoKey", self.app.shutdown)
# TODO: maybe import this from configwindow.py ? The exact same Action is defined in the main window.
self.action_enable_monitoring = self._create_action(
None, "&Enable Monitoring", self.app.toggle_service,
"Pause the phrase expansion and script execution, both by abbreviations and hotkeys.\n"
"The global hotkeys to show the main window and to toggle this setting, as defined in the AutoKey "
"settings, are not affected and will work regardless."
)
self.action_enable_monitoring.setCheckable(True)
self.action_enable_monitoring.setChecked(self.app.service.is_running())
self.action_enable_monitoring.setDisabled(self.app.serviceDisabled)
# Sync action state with internal service state
self.app.monitoring_disabled.connect(self.action_enable_monitoring.setChecked) | python | def _create_static_actions(self):
"""
Create all static menu actions. The created actions will be placed in the tray icon context menu.
"""
logger.info("Creating static context menu actions.")
self.action_view_script_error = self._create_action(
None, "&View script error", self.reset_tray_icon,
"View the last script error."
)
self.action_view_script_error.triggered.connect(self.app.show_script_error)
# The action should disable itself
self.action_view_script_error.setDisabled(True)
self.action_view_script_error.triggered.connect(self.action_view_script_error.setEnabled)
self.action_hide_icon = self._create_action(
"edit-clear", "Temporarily &Hide Icon", self.hide,
"Temporarily hide the system tray icon.\nUse the settings to hide it permanently."
)
self.action_show_config_window = self._create_action(
"configure", "&Show Main Window", self.app.show_configure,
"Show the main AutoKey window. This does the same as left clicking the tray icon."
)
self.action_quit = self._create_action("application-exit", "Exit AutoKey", self.app.shutdown)
# TODO: maybe import this from configwindow.py ? The exact same Action is defined in the main window.
self.action_enable_monitoring = self._create_action(
None, "&Enable Monitoring", self.app.toggle_service,
"Pause the phrase expansion and script execution, both by abbreviations and hotkeys.\n"
"The global hotkeys to show the main window and to toggle this setting, as defined in the AutoKey "
"settings, are not affected and will work regardless."
)
self.action_enable_monitoring.setCheckable(True)
self.action_enable_monitoring.setChecked(self.app.service.is_running())
self.action_enable_monitoring.setDisabled(self.app.serviceDisabled)
# Sync action state with internal service state
self.app.monitoring_disabled.connect(self.action_enable_monitoring.setChecked) | [
"def",
"_create_static_actions",
"(",
"self",
")",
":",
"logger",
".",
"info",
"(",
"\"Creating static context menu actions.\"",
")",
"self",
".",
"action_view_script_error",
"=",
"self",
".",
"_create_action",
"(",
"None",
",",
"\"&View script error\"",
",",
"self",
... | Create all static menu actions. The created actions will be placed in the tray icon context menu. | [
"Create",
"all",
"static",
"menu",
"actions",
".",
"The",
"created",
"actions",
"will",
"be",
"placed",
"in",
"the",
"tray",
"icon",
"context",
"menu",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/notifier.py#L109-L142 | train | 220,642 |
autokey/autokey | lib/autokey/qtui/notifier.py | Notifier._fill_context_menu_with_model_item_actions | def _fill_context_menu_with_model_item_actions(self, context_menu: QMenu):
"""
Find all model items that should be available in the context menu and create QActions for each, by
using the available logic in popupmenu.PopupMenu.
"""
# Get phrase folders to add to main menu
logger.info("Rebuilding model item actions, adding all items marked for access through the tray icon.")
folders = [folder for folder in self.config_manager.allFolders if folder.show_in_tray_menu]
items = [item for item in self.config_manager.allItems if item.show_in_tray_menu]
# Only extract the QActions, but discard the PopupMenu instance.
# This is done, because the PopupMenu class is not directly usable as a context menu here.
menu = popupmenu.PopupMenu(self.app.service, folders, items, False, "AutoKey")
new_item_actions = menu.actions()
context_menu.addActions(new_item_actions)
for action in new_item_actions: # type: QAction
# QMenu does not take the ownership when adding QActions, so manually re-parent all actions.
# This causes the QActions to be destroyed when the context menu is cleared or re-created.
action.setParent(context_menu)
if not context_menu.isEmpty():
# Avoid a stray separator line, if no items are marked for display in the context menu.
context_menu.addSeparator() | python | def _fill_context_menu_with_model_item_actions(self, context_menu: QMenu):
"""
Find all model items that should be available in the context menu and create QActions for each, by
using the available logic in popupmenu.PopupMenu.
"""
# Get phrase folders to add to main menu
logger.info("Rebuilding model item actions, adding all items marked for access through the tray icon.")
folders = [folder for folder in self.config_manager.allFolders if folder.show_in_tray_menu]
items = [item for item in self.config_manager.allItems if item.show_in_tray_menu]
# Only extract the QActions, but discard the PopupMenu instance.
# This is done, because the PopupMenu class is not directly usable as a context menu here.
menu = popupmenu.PopupMenu(self.app.service, folders, items, False, "AutoKey")
new_item_actions = menu.actions()
context_menu.addActions(new_item_actions)
for action in new_item_actions: # type: QAction
# QMenu does not take the ownership when adding QActions, so manually re-parent all actions.
# This causes the QActions to be destroyed when the context menu is cleared or re-created.
action.setParent(context_menu)
if not context_menu.isEmpty():
# Avoid a stray separator line, if no items are marked for display in the context menu.
context_menu.addSeparator() | [
"def",
"_fill_context_menu_with_model_item_actions",
"(",
"self",
",",
"context_menu",
":",
"QMenu",
")",
":",
"# Get phrase folders to add to main menu",
"logger",
".",
"info",
"(",
"\"Rebuilding model item actions, adding all items marked for access through the tray icon.\"",
")",
... | Find all model items that should be available in the context menu and create QActions for each, by
using the available logic in popupmenu.PopupMenu. | [
"Find",
"all",
"model",
"items",
"that",
"should",
"be",
"available",
"in",
"the",
"context",
"menu",
"and",
"create",
"QActions",
"for",
"each",
"by",
"using",
"the",
"available",
"logic",
"in",
"popupmenu",
".",
"PopupMenu",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/notifier.py#L144-L165 | train | 220,643 |
autokey/autokey | lib/autokey/qtui/notifier.py | Notifier._build_menu | def _build_menu(self, context_menu: QMenu):
"""Build the context menu."""
logger.debug("Show tray icon enabled in settings: {}".format(cm.ConfigManager.SETTINGS[cm.SHOW_TRAY_ICON]))
# Items selected for display are shown on top
self._fill_context_menu_with_model_item_actions(context_menu)
# The static actions are added at the bottom
context_menu.addAction(self.action_view_script_error)
context_menu.addAction(self.action_enable_monitoring)
context_menu.addAction(self.action_hide_icon)
context_menu.addAction(self.action_show_config_window)
context_menu.addAction(self.action_quit) | python | def _build_menu(self, context_menu: QMenu):
"""Build the context menu."""
logger.debug("Show tray icon enabled in settings: {}".format(cm.ConfigManager.SETTINGS[cm.SHOW_TRAY_ICON]))
# Items selected for display are shown on top
self._fill_context_menu_with_model_item_actions(context_menu)
# The static actions are added at the bottom
context_menu.addAction(self.action_view_script_error)
context_menu.addAction(self.action_enable_monitoring)
context_menu.addAction(self.action_hide_icon)
context_menu.addAction(self.action_show_config_window)
context_menu.addAction(self.action_quit) | [
"def",
"_build_menu",
"(",
"self",
",",
"context_menu",
":",
"QMenu",
")",
":",
"logger",
".",
"debug",
"(",
"\"Show tray icon enabled in settings: {}\"",
".",
"format",
"(",
"cm",
".",
"ConfigManager",
".",
"SETTINGS",
"[",
"cm",
".",
"SHOW_TRAY_ICON",
"]",
"... | Build the context menu. | [
"Build",
"the",
"context",
"menu",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/notifier.py#L167-L177 | train | 220,644 |
autokey/autokey | lib/autokey/configmanager.py | _persist_settings | def _persist_settings(config_manager):
"""
Write the settings, including the persistent global script Store.
The Store instance might contain arbitrary user data, like function objects, OpenCL contexts, or whatever other
non-serializable objects, both as keys or values.
Try to serialize the data, and if it fails, fall back to checking the store and removing all non-serializable
data.
"""
serializable_data = config_manager.get_serializable()
try:
_try_persist_settings(serializable_data)
except (TypeError, ValueError):
# The user added non-serializable data to the store, so remove all non-serializable keys or values.
_remove_non_serializable_store_entries(serializable_data["settings"][SCRIPT_GLOBALS])
_try_persist_settings(serializable_data) | python | def _persist_settings(config_manager):
"""
Write the settings, including the persistent global script Store.
The Store instance might contain arbitrary user data, like function objects, OpenCL contexts, or whatever other
non-serializable objects, both as keys or values.
Try to serialize the data, and if it fails, fall back to checking the store and removing all non-serializable
data.
"""
serializable_data = config_manager.get_serializable()
try:
_try_persist_settings(serializable_data)
except (TypeError, ValueError):
# The user added non-serializable data to the store, so remove all non-serializable keys or values.
_remove_non_serializable_store_entries(serializable_data["settings"][SCRIPT_GLOBALS])
_try_persist_settings(serializable_data) | [
"def",
"_persist_settings",
"(",
"config_manager",
")",
":",
"serializable_data",
"=",
"config_manager",
".",
"get_serializable",
"(",
")",
"try",
":",
"_try_persist_settings",
"(",
"serializable_data",
")",
"except",
"(",
"TypeError",
",",
"ValueError",
")",
":",
... | Write the settings, including the persistent global script Store.
The Store instance might contain arbitrary user data, like function objects, OpenCL contexts, or whatever other
non-serializable objects, both as keys or values.
Try to serialize the data, and if it fails, fall back to checking the store and removing all non-serializable
data. | [
"Write",
"the",
"settings",
"including",
"the",
"persistent",
"global",
"script",
"Store",
".",
"The",
"Store",
"instance",
"might",
"contain",
"arbitrary",
"user",
"data",
"like",
"function",
"objects",
"OpenCL",
"contexts",
"or",
"whatever",
"other",
"non",
"-... | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/configmanager.py#L118-L132 | train | 220,645 |
autokey/autokey | lib/autokey/configmanager.py | _remove_non_serializable_store_entries | def _remove_non_serializable_store_entries(store: dict):
"""
This function is called if there are non-serializable items in the global script storage.
This function removes all such items.
"""
removed_key_list = []
for key, value in store.items():
if not (_is_serializable(key) and _is_serializable(value)):
_logger.info("Remove non-serializable item from the global script store. Key: '{}', Value: '{}'. "
"This item cannot be saved and therefore will be lost.".format(key, value))
removed_key_list.append(key)
for key in removed_key_list:
del store[key] | python | def _remove_non_serializable_store_entries(store: dict):
"""
This function is called if there are non-serializable items in the global script storage.
This function removes all such items.
"""
removed_key_list = []
for key, value in store.items():
if not (_is_serializable(key) and _is_serializable(value)):
_logger.info("Remove non-serializable item from the global script store. Key: '{}', Value: '{}'. "
"This item cannot be saved and therefore will be lost.".format(key, value))
removed_key_list.append(key)
for key in removed_key_list:
del store[key] | [
"def",
"_remove_non_serializable_store_entries",
"(",
"store",
":",
"dict",
")",
":",
"removed_key_list",
"=",
"[",
"]",
"for",
"key",
",",
"value",
"in",
"store",
".",
"items",
"(",
")",
":",
"if",
"not",
"(",
"_is_serializable",
"(",
"key",
")",
"and",
... | This function is called if there are non-serializable items in the global script storage.
This function removes all such items. | [
"This",
"function",
"is",
"called",
"if",
"there",
"are",
"non",
"-",
"serializable",
"items",
"in",
"the",
"global",
"script",
"storage",
".",
"This",
"function",
"removes",
"all",
"such",
"items",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/configmanager.py#L145-L157 | train | 220,646 |
autokey/autokey | lib/autokey/configmanager.py | get_autostart | def get_autostart() -> AutostartSettings:
"""Returns the autostart settings as read from the system."""
autostart_file = Path(common.AUTOSTART_DIR) / "autokey.desktop"
if not autostart_file.exists():
return AutostartSettings(None, False)
else:
return _extract_data_from_desktop_file(autostart_file) | python | def get_autostart() -> AutostartSettings:
"""Returns the autostart settings as read from the system."""
autostart_file = Path(common.AUTOSTART_DIR) / "autokey.desktop"
if not autostart_file.exists():
return AutostartSettings(None, False)
else:
return _extract_data_from_desktop_file(autostart_file) | [
"def",
"get_autostart",
"(",
")",
"->",
"AutostartSettings",
":",
"autostart_file",
"=",
"Path",
"(",
"common",
".",
"AUTOSTART_DIR",
")",
"/",
"\"autokey.desktop\"",
"if",
"not",
"autostart_file",
".",
"exists",
"(",
")",
":",
"return",
"AutostartSettings",
"("... | Returns the autostart settings as read from the system. | [
"Returns",
"the",
"autostart",
"settings",
"as",
"read",
"from",
"the",
"system",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/configmanager.py#L172-L178 | train | 220,647 |
autokey/autokey | lib/autokey/configmanager.py | _create_autostart_entry | def _create_autostart_entry(autostart_data: AutostartSettings, autostart_file: Path):
"""Create an autostart .desktop file in the autostart directory, if possible."""
try:
source_desktop_file = get_source_desktop_file(autostart_data.desktop_file_name)
except FileNotFoundError:
_logger.exception("Failed to find a usable .desktop file! Unable to find: {}".format(
autostart_data.desktop_file_name))
else:
_logger.debug("Found source desktop file that will be placed into the autostart directory: {}".format(
source_desktop_file))
with open(str(source_desktop_file), "r") as opened_source_desktop_file:
desktop_file_content = opened_source_desktop_file.read()
desktop_file_content = "\n".join(_manage_autostart_desktop_file_launch_flags(
desktop_file_content, autostart_data.switch_show_configure
)) + "\n"
with open(str(autostart_file), "w", encoding="UTF-8") as opened_autostart_file:
opened_autostart_file.write(desktop_file_content)
_logger.debug("Written desktop file: {}".format(autostart_file)) | python | def _create_autostart_entry(autostart_data: AutostartSettings, autostart_file: Path):
"""Create an autostart .desktop file in the autostart directory, if possible."""
try:
source_desktop_file = get_source_desktop_file(autostart_data.desktop_file_name)
except FileNotFoundError:
_logger.exception("Failed to find a usable .desktop file! Unable to find: {}".format(
autostart_data.desktop_file_name))
else:
_logger.debug("Found source desktop file that will be placed into the autostart directory: {}".format(
source_desktop_file))
with open(str(source_desktop_file), "r") as opened_source_desktop_file:
desktop_file_content = opened_source_desktop_file.read()
desktop_file_content = "\n".join(_manage_autostart_desktop_file_launch_flags(
desktop_file_content, autostart_data.switch_show_configure
)) + "\n"
with open(str(autostart_file), "w", encoding="UTF-8") as opened_autostart_file:
opened_autostart_file.write(desktop_file_content)
_logger.debug("Written desktop file: {}".format(autostart_file)) | [
"def",
"_create_autostart_entry",
"(",
"autostart_data",
":",
"AutostartSettings",
",",
"autostart_file",
":",
"Path",
")",
":",
"try",
":",
"source_desktop_file",
"=",
"get_source_desktop_file",
"(",
"autostart_data",
".",
"desktop_file_name",
")",
"except",
"FileNotFo... | Create an autostart .desktop file in the autostart directory, if possible. | [
"Create",
"an",
"autostart",
".",
"desktop",
"file",
"in",
"the",
"autostart",
"directory",
"if",
"possible",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/configmanager.py#L205-L222 | train | 220,648 |
autokey/autokey | lib/autokey/configmanager.py | delete_autostart_entry | def delete_autostart_entry():
"""Remove a present autostart entry. If none is found, nothing happens."""
autostart_file = Path(common.AUTOSTART_DIR) / "autokey.desktop"
if autostart_file.exists():
autostart_file.unlink()
_logger.info("Deleted old autostart entry: {}".format(autostart_file)) | python | def delete_autostart_entry():
"""Remove a present autostart entry. If none is found, nothing happens."""
autostart_file = Path(common.AUTOSTART_DIR) / "autokey.desktop"
if autostart_file.exists():
autostart_file.unlink()
_logger.info("Deleted old autostart entry: {}".format(autostart_file)) | [
"def",
"delete_autostart_entry",
"(",
")",
":",
"autostart_file",
"=",
"Path",
"(",
"common",
".",
"AUTOSTART_DIR",
")",
"/",
"\"autokey.desktop\"",
"if",
"autostart_file",
".",
"exists",
"(",
")",
":",
"autostart_file",
".",
"unlink",
"(",
")",
"_logger",
"."... | Remove a present autostart entry. If none is found, nothing happens. | [
"Remove",
"a",
"present",
"autostart",
"entry",
".",
"If",
"none",
"is",
"found",
"nothing",
"happens",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/configmanager.py#L225-L230 | train | 220,649 |
autokey/autokey | lib/autokey/configmanager.py | apply_settings | def apply_settings(settings):
"""
Allows new settings to be added without users having to lose all their configuration
"""
for key, value in settings.items():
ConfigManager.SETTINGS[key] = value | python | def apply_settings(settings):
"""
Allows new settings to be added without users having to lose all their configuration
"""
for key, value in settings.items():
ConfigManager.SETTINGS[key] = value | [
"def",
"apply_settings",
"(",
"settings",
")",
":",
"for",
"key",
",",
"value",
"in",
"settings",
".",
"items",
"(",
")",
":",
"ConfigManager",
".",
"SETTINGS",
"[",
"key",
"]",
"=",
"value"
] | Allows new settings to be added without users having to lose all their configuration | [
"Allows",
"new",
"settings",
"to",
"be",
"added",
"without",
"users",
"having",
"to",
"lose",
"all",
"their",
"configuration"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/configmanager.py#L278-L283 | train | 220,650 |
autokey/autokey | lib/autokey/configmanager.py | ConfigManager.check_abbreviation_unique | def check_abbreviation_unique(self, abbreviation, newFilterPattern, targetItem):
"""
Checks that the given abbreviation is not already in use.
@param abbreviation: the abbreviation to check
@param newFilterPattern:
@param targetItem: the phrase for which the abbreviation to be used
"""
for item in self.allFolders:
if model.TriggerMode.ABBREVIATION in item.modes:
if abbreviation in item.abbreviations and item.filter_matches(newFilterPattern):
return item is targetItem, item
for item in self.allItems:
if model.TriggerMode.ABBREVIATION in item.modes:
if abbreviation in item.abbreviations and item.filter_matches(newFilterPattern):
return item is targetItem, item
return True, None | python | def check_abbreviation_unique(self, abbreviation, newFilterPattern, targetItem):
"""
Checks that the given abbreviation is not already in use.
@param abbreviation: the abbreviation to check
@param newFilterPattern:
@param targetItem: the phrase for which the abbreviation to be used
"""
for item in self.allFolders:
if model.TriggerMode.ABBREVIATION in item.modes:
if abbreviation in item.abbreviations and item.filter_matches(newFilterPattern):
return item is targetItem, item
for item in self.allItems:
if model.TriggerMode.ABBREVIATION in item.modes:
if abbreviation in item.abbreviations and item.filter_matches(newFilterPattern):
return item is targetItem, item
return True, None | [
"def",
"check_abbreviation_unique",
"(",
"self",
",",
"abbreviation",
",",
"newFilterPattern",
",",
"targetItem",
")",
":",
"for",
"item",
"in",
"self",
".",
"allFolders",
":",
"if",
"model",
".",
"TriggerMode",
".",
"ABBREVIATION",
"in",
"item",
".",
"modes",... | Checks that the given abbreviation is not already in use.
@param abbreviation: the abbreviation to check
@param newFilterPattern:
@param targetItem: the phrase for which the abbreviation to be used | [
"Checks",
"that",
"the",
"given",
"abbreviation",
"is",
"not",
"already",
"in",
"use",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/configmanager.py#L837-L855 | train | 220,651 |
autokey/autokey | lib/autokey/configmanager.py | ConfigManager.check_hotkey_unique | def check_hotkey_unique(self, modifiers, hotKey, newFilterPattern, targetItem):
"""
Checks that the given hotkey is not already in use. Also checks the
special hotkeys configured from the advanced settings dialog.
@param modifiers: modifiers for the hotkey
@param hotKey: the hotkey to check
@param newFilterPattern:
@param targetItem: the phrase for which the hotKey to be used
"""
for item in self.allFolders:
if model.TriggerMode.HOTKEY in item.modes:
if item.modifiers == modifiers and item.hotKey == hotKey and item.filter_matches(newFilterPattern):
return item is targetItem, item
for item in self.allItems:
if model.TriggerMode.HOTKEY in item.modes:
if item.modifiers == modifiers and item.hotKey == hotKey and item.filter_matches(newFilterPattern):
return item is targetItem, item
for item in self.globalHotkeys:
if item.enabled:
if item.modifiers == modifiers and item.hotKey == hotKey and item.filter_matches(newFilterPattern):
return item is targetItem, item
return True, None | python | def check_hotkey_unique(self, modifiers, hotKey, newFilterPattern, targetItem):
"""
Checks that the given hotkey is not already in use. Also checks the
special hotkeys configured from the advanced settings dialog.
@param modifiers: modifiers for the hotkey
@param hotKey: the hotkey to check
@param newFilterPattern:
@param targetItem: the phrase for which the hotKey to be used
"""
for item in self.allFolders:
if model.TriggerMode.HOTKEY in item.modes:
if item.modifiers == modifiers and item.hotKey == hotKey and item.filter_matches(newFilterPattern):
return item is targetItem, item
for item in self.allItems:
if model.TriggerMode.HOTKEY in item.modes:
if item.modifiers == modifiers and item.hotKey == hotKey and item.filter_matches(newFilterPattern):
return item is targetItem, item
for item in self.globalHotkeys:
if item.enabled:
if item.modifiers == modifiers and item.hotKey == hotKey and item.filter_matches(newFilterPattern):
return item is targetItem, item
return True, None | [
"def",
"check_hotkey_unique",
"(",
"self",
",",
"modifiers",
",",
"hotKey",
",",
"newFilterPattern",
",",
"targetItem",
")",
":",
"for",
"item",
"in",
"self",
".",
"allFolders",
":",
"if",
"model",
".",
"TriggerMode",
".",
"HOTKEY",
"in",
"item",
".",
"mod... | Checks that the given hotkey is not already in use. Also checks the
special hotkeys configured from the advanced settings dialog.
@param modifiers: modifiers for the hotkey
@param hotKey: the hotkey to check
@param newFilterPattern:
@param targetItem: the phrase for which the hotKey to be used | [
"Checks",
"that",
"the",
"given",
"hotkey",
"is",
"not",
"already",
"in",
"use",
".",
"Also",
"checks",
"the",
"special",
"hotkeys",
"configured",
"from",
"the",
"advanced",
"settings",
"dialog",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/configmanager.py#L888-L913 | train | 220,652 |
autokey/autokey | lib/autokey/qtui/dialogs/hotkeysettings.py | HotkeySettingsDialog.on_setButton_pressed | def on_setButton_pressed(self):
"""
Start recording a key combination when the user clicks on the setButton.
The button itself is automatically disabled during the recording process.
"""
self.keyLabel.setText("Press a key or combination...") # TODO: i18n
logger.debug("User starts to record a key combination.")
self.grabber = iomediator.KeyGrabber(self)
self.grabber.start() | python | def on_setButton_pressed(self):
"""
Start recording a key combination when the user clicks on the setButton.
The button itself is automatically disabled during the recording process.
"""
self.keyLabel.setText("Press a key or combination...") # TODO: i18n
logger.debug("User starts to record a key combination.")
self.grabber = iomediator.KeyGrabber(self)
self.grabber.start() | [
"def",
"on_setButton_pressed",
"(",
"self",
")",
":",
"self",
".",
"keyLabel",
".",
"setText",
"(",
"\"Press a key or combination...\"",
")",
"# TODO: i18n",
"logger",
".",
"debug",
"(",
"\"User starts to record a key combination.\"",
")",
"self",
".",
"grabber",
"=",... | Start recording a key combination when the user clicks on the setButton.
The button itself is automatically disabled during the recording process. | [
"Start",
"recording",
"a",
"key",
"combination",
"when",
"the",
"user",
"clicks",
"on",
"the",
"setButton",
".",
"The",
"button",
"itself",
"is",
"automatically",
"disabled",
"during",
"the",
"recording",
"process",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/dialogs/hotkeysettings.py#L68-L76 | train | 220,653 |
autokey/autokey | lib/autokey/qtui/dialogs/hotkeysettings.py | HotkeySettingsDialog.set_key | def set_key(self, key, modifiers: typing.List[Key]=None):
"""This is called when the user successfully finishes recording a key combination."""
if modifiers is None:
modifiers = [] # type: typing.List[Key]
if key in self.KEY_MAP:
key = self.KEY_MAP[key]
self._setKeyLabel(key)
self.key = key
self.controlButton.setChecked(Key.CONTROL in modifiers)
self.altButton.setChecked(Key.ALT in modifiers)
self.shiftButton.setChecked(Key.SHIFT in modifiers)
self.superButton.setChecked(Key.SUPER in modifiers)
self.hyperButton.setChecked(Key.HYPER in modifiers)
self.metaButton.setChecked(Key.META in modifiers)
self.recording_finished.emit(True) | python | def set_key(self, key, modifiers: typing.List[Key]=None):
"""This is called when the user successfully finishes recording a key combination."""
if modifiers is None:
modifiers = [] # type: typing.List[Key]
if key in self.KEY_MAP:
key = self.KEY_MAP[key]
self._setKeyLabel(key)
self.key = key
self.controlButton.setChecked(Key.CONTROL in modifiers)
self.altButton.setChecked(Key.ALT in modifiers)
self.shiftButton.setChecked(Key.SHIFT in modifiers)
self.superButton.setChecked(Key.SUPER in modifiers)
self.hyperButton.setChecked(Key.HYPER in modifiers)
self.metaButton.setChecked(Key.META in modifiers)
self.recording_finished.emit(True) | [
"def",
"set_key",
"(",
"self",
",",
"key",
",",
"modifiers",
":",
"typing",
".",
"List",
"[",
"Key",
"]",
"=",
"None",
")",
":",
"if",
"modifiers",
"is",
"None",
":",
"modifiers",
"=",
"[",
"]",
"# type: typing.List[Key]",
"if",
"key",
"in",
"self",
... | This is called when the user successfully finishes recording a key combination. | [
"This",
"is",
"called",
"when",
"the",
"user",
"successfully",
"finishes",
"recording",
"a",
"key",
"combination",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/dialogs/hotkeysettings.py#L127-L141 | train | 220,654 |
autokey/autokey | lib/autokey/qtui/dialogs/hotkeysettings.py | HotkeySettingsDialog.cancel_grab | def cancel_grab(self):
"""
This is called when the user cancels a recording.
Canceling is done by clicking with the left mouse button.
"""
logger.debug("User canceled hotkey recording.")
self.recording_finished.emit(True)
self._setKeyLabel(self.key if self.key is not None else "(None)") | python | def cancel_grab(self):
"""
This is called when the user cancels a recording.
Canceling is done by clicking with the left mouse button.
"""
logger.debug("User canceled hotkey recording.")
self.recording_finished.emit(True)
self._setKeyLabel(self.key if self.key is not None else "(None)") | [
"def",
"cancel_grab",
"(",
"self",
")",
":",
"logger",
".",
"debug",
"(",
"\"User canceled hotkey recording.\"",
")",
"self",
".",
"recording_finished",
".",
"emit",
"(",
"True",
")",
"self",
".",
"_setKeyLabel",
"(",
"self",
".",
"key",
"if",
"self",
".",
... | This is called when the user cancels a recording.
Canceling is done by clicking with the left mouse button. | [
"This",
"is",
"called",
"when",
"the",
"user",
"cancels",
"a",
"recording",
".",
"Canceling",
"is",
"done",
"by",
"clicking",
"with",
"the",
"left",
"mouse",
"button",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/dialogs/hotkeysettings.py#L143-L150 | train | 220,655 |
autokey/autokey | lib/autokey/iomediator/_iomediator.py | IoMediator.handle_modifier_down | def handle_modifier_down(self, modifier):
"""
Updates the state of the given modifier key to 'pressed'
"""
_logger.debug("%s pressed", modifier)
if modifier in (Key.CAPSLOCK, Key.NUMLOCK):
if self.modifiers[modifier]:
self.modifiers[modifier] = False
else:
self.modifiers[modifier] = True
else:
self.modifiers[modifier] = True | python | def handle_modifier_down(self, modifier):
"""
Updates the state of the given modifier key to 'pressed'
"""
_logger.debug("%s pressed", modifier)
if modifier in (Key.CAPSLOCK, Key.NUMLOCK):
if self.modifiers[modifier]:
self.modifiers[modifier] = False
else:
self.modifiers[modifier] = True
else:
self.modifiers[modifier] = True | [
"def",
"handle_modifier_down",
"(",
"self",
",",
"modifier",
")",
":",
"_logger",
".",
"debug",
"(",
"\"%s pressed\"",
",",
"modifier",
")",
"if",
"modifier",
"in",
"(",
"Key",
".",
"CAPSLOCK",
",",
"Key",
".",
"NUMLOCK",
")",
":",
"if",
"self",
".",
"... | Updates the state of the given modifier key to 'pressed' | [
"Updates",
"the",
"state",
"of",
"the",
"given",
"modifier",
"key",
"to",
"pressed"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/iomediator/_iomediator.py#L72-L83 | train | 220,656 |
autokey/autokey | lib/autokey/iomediator/_iomediator.py | IoMediator.handle_modifier_up | def handle_modifier_up(self, modifier):
"""
Updates the state of the given modifier key to 'released'.
"""
_logger.debug("%s released", modifier)
# Caps and num lock are handled on key down only
if modifier not in (Key.CAPSLOCK, Key.NUMLOCK):
self.modifiers[modifier] = False | python | def handle_modifier_up(self, modifier):
"""
Updates the state of the given modifier key to 'released'.
"""
_logger.debug("%s released", modifier)
# Caps and num lock are handled on key down only
if modifier not in (Key.CAPSLOCK, Key.NUMLOCK):
self.modifiers[modifier] = False | [
"def",
"handle_modifier_up",
"(",
"self",
",",
"modifier",
")",
":",
"_logger",
".",
"debug",
"(",
"\"%s released\"",
",",
"modifier",
")",
"# Caps and num lock are handled on key down only",
"if",
"modifier",
"not",
"in",
"(",
"Key",
".",
"CAPSLOCK",
",",
"Key",
... | Updates the state of the given modifier key to 'released'. | [
"Updates",
"the",
"state",
"of",
"the",
"given",
"modifier",
"key",
"to",
"released",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/iomediator/_iomediator.py#L85-L92 | train | 220,657 |
autokey/autokey | lib/autokey/iomediator/_iomediator.py | IoMediator.send_string | def send_string(self, string: str):
"""
Sends the given string for output.
"""
if not string:
return
string = string.replace('\n', "<enter>")
string = string.replace('\t', "<tab>")
_logger.debug("Send via event interface")
self.__clearModifiers()
modifiers = []
for section in KEY_SPLIT_RE.split(string):
if len(section) > 0:
if Key.is_key(section[:-1]) and section[-1] == '+' and section[:-1] in MODIFIERS:
# Section is a modifier application (modifier followed by '+')
modifiers.append(section[:-1])
else:
if len(modifiers) > 0:
# Modifiers ready for application - send modified key
if Key.is_key(section):
self.interface.send_modified_key(section, modifiers)
modifiers = []
else:
self.interface.send_modified_key(section[0], modifiers)
if len(section) > 1:
self.interface.send_string(section[1:])
modifiers = []
else:
# Normal string/key operation
if Key.is_key(section):
self.interface.send_key(section)
else:
self.interface.send_string(section)
self.__reapplyModifiers() | python | def send_string(self, string: str):
"""
Sends the given string for output.
"""
if not string:
return
string = string.replace('\n', "<enter>")
string = string.replace('\t', "<tab>")
_logger.debug("Send via event interface")
self.__clearModifiers()
modifiers = []
for section in KEY_SPLIT_RE.split(string):
if len(section) > 0:
if Key.is_key(section[:-1]) and section[-1] == '+' and section[:-1] in MODIFIERS:
# Section is a modifier application (modifier followed by '+')
modifiers.append(section[:-1])
else:
if len(modifiers) > 0:
# Modifiers ready for application - send modified key
if Key.is_key(section):
self.interface.send_modified_key(section, modifiers)
modifiers = []
else:
self.interface.send_modified_key(section[0], modifiers)
if len(section) > 1:
self.interface.send_string(section[1:])
modifiers = []
else:
# Normal string/key operation
if Key.is_key(section):
self.interface.send_key(section)
else:
self.interface.send_string(section)
self.__reapplyModifiers() | [
"def",
"send_string",
"(",
"self",
",",
"string",
":",
"str",
")",
":",
"if",
"not",
"string",
":",
"return",
"string",
"=",
"string",
".",
"replace",
"(",
"'\\n'",
",",
"\"<enter>\"",
")",
"string",
"=",
"string",
".",
"replace",
"(",
"'\\t'",
",",
... | Sends the given string for output. | [
"Sends",
"the",
"given",
"string",
"for",
"output",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/iomediator/_iomediator.py#L124-L161 | train | 220,658 |
autokey/autokey | lib/autokey/iomediator/_iomediator.py | IoMediator.send_left | def send_left(self, count):
"""
Sends the given number of left key presses.
"""
for i in range(count):
self.interface.send_key(Key.LEFT) | python | def send_left(self, count):
"""
Sends the given number of left key presses.
"""
for i in range(count):
self.interface.send_key(Key.LEFT) | [
"def",
"send_left",
"(",
"self",
",",
"count",
")",
":",
"for",
"i",
"in",
"range",
"(",
"count",
")",
":",
"self",
".",
"interface",
".",
"send_key",
"(",
"Key",
".",
"LEFT",
")"
] | Sends the given number of left key presses. | [
"Sends",
"the",
"given",
"number",
"of",
"left",
"key",
"presses",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/iomediator/_iomediator.py#L200-L205 | train | 220,659 |
autokey/autokey | lib/autokey/iomediator/_iomediator.py | IoMediator.send_up | def send_up(self, count):
"""
Sends the given number of up key presses.
"""
for i in range(count):
self.interface.send_key(Key.UP) | python | def send_up(self, count):
"""
Sends the given number of up key presses.
"""
for i in range(count):
self.interface.send_key(Key.UP) | [
"def",
"send_up",
"(",
"self",
",",
"count",
")",
":",
"for",
"i",
"in",
"range",
"(",
"count",
")",
":",
"self",
".",
"interface",
".",
"send_key",
"(",
"Key",
".",
"UP",
")"
] | Sends the given number of up key presses. | [
"Sends",
"the",
"given",
"number",
"of",
"up",
"key",
"presses",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/iomediator/_iomediator.py#L211-L216 | train | 220,660 |
autokey/autokey | lib/autokey/iomediator/_iomediator.py | IoMediator.send_backspace | def send_backspace(self, count):
"""
Sends the given number of backspace key presses.
"""
for i in range(count):
self.interface.send_key(Key.BACKSPACE) | python | def send_backspace(self, count):
"""
Sends the given number of backspace key presses.
"""
for i in range(count):
self.interface.send_key(Key.BACKSPACE) | [
"def",
"send_backspace",
"(",
"self",
",",
"count",
")",
":",
"for",
"i",
"in",
"range",
"(",
"count",
")",
":",
"self",
".",
"interface",
".",
"send_key",
"(",
"Key",
".",
"BACKSPACE",
")"
] | Sends the given number of backspace key presses. | [
"Sends",
"the",
"given",
"number",
"of",
"backspace",
"key",
"presses",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/iomediator/_iomediator.py#L218-L223 | train | 220,661 |
autokey/autokey | lib/autokey/scripting.py | Keyboard.fake_keypress | def fake_keypress(self, key, repeat=1):
"""
Fake a keypress
Usage: C{keyboard.fake_keypress(key, repeat=1)}
Uses XTest to 'fake' a keypress. This is useful to send keypresses to some
applications which won't respond to keyboard.send_key()
@param key: they key to be sent (e.g. "s" or "<enter>")
@param repeat: number of times to repeat the key event
"""
for _ in range(repeat):
self.mediator.fake_keypress(key) | python | def fake_keypress(self, key, repeat=1):
"""
Fake a keypress
Usage: C{keyboard.fake_keypress(key, repeat=1)}
Uses XTest to 'fake' a keypress. This is useful to send keypresses to some
applications which won't respond to keyboard.send_key()
@param key: they key to be sent (e.g. "s" or "<enter>")
@param repeat: number of times to repeat the key event
"""
for _ in range(repeat):
self.mediator.fake_keypress(key) | [
"def",
"fake_keypress",
"(",
"self",
",",
"key",
",",
"repeat",
"=",
"1",
")",
":",
"for",
"_",
"in",
"range",
"(",
"repeat",
")",
":",
"self",
".",
"mediator",
".",
"fake_keypress",
"(",
"key",
")"
] | Fake a keypress
Usage: C{keyboard.fake_keypress(key, repeat=1)}
Uses XTest to 'fake' a keypress. This is useful to send keypresses to some
applications which won't respond to keyboard.send_key()
@param key: they key to be sent (e.g. "s" or "<enter>")
@param repeat: number of times to repeat the key event | [
"Fake",
"a",
"keypress"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/scripting.py#L148-L161 | train | 220,662 |
autokey/autokey | lib/autokey/scripting.py | QtDialog.info_dialog | def info_dialog(self, title="Information", message="", **kwargs):
"""
Show an information dialog
Usage: C{dialog.info_dialog(title="Information", message="", **kwargs)}
@param title: window title for the dialog
@param message: message displayed in the dialog
@return: a tuple containing the exit code and user input
@rtype: C{DialogData(int, str)}
"""
return self._run_kdialog(title, ["--msgbox", message], kwargs) | python | def info_dialog(self, title="Information", message="", **kwargs):
"""
Show an information dialog
Usage: C{dialog.info_dialog(title="Information", message="", **kwargs)}
@param title: window title for the dialog
@param message: message displayed in the dialog
@return: a tuple containing the exit code and user input
@rtype: C{DialogData(int, str)}
"""
return self._run_kdialog(title, ["--msgbox", message], kwargs) | [
"def",
"info_dialog",
"(",
"self",
",",
"title",
"=",
"\"Information\"",
",",
"message",
"=",
"\"\"",
",",
"*",
"*",
"kwargs",
")",
":",
"return",
"self",
".",
"_run_kdialog",
"(",
"title",
",",
"[",
"\"--msgbox\"",
",",
"message",
"]",
",",
"kwargs",
... | Show an information dialog
Usage: C{dialog.info_dialog(title="Information", message="", **kwargs)}
@param title: window title for the dialog
@param message: message displayed in the dialog
@return: a tuple containing the exit code and user input
@rtype: C{DialogData(int, str)} | [
"Show",
"an",
"information",
"dialog"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/scripting.py#L265-L276 | train | 220,663 |
autokey/autokey | lib/autokey/scripting.py | QtDialog.calendar | def calendar(self, title="Choose a date", format_str="%Y-%m-%d", date="today", **kwargs):
"""
Show a calendar dialog
Usage: C{dialog.calendar_dialog(title="Choose a date", format="%Y-%m-%d", date="YYYY-MM-DD", **kwargs)}
Note: the format and date parameters are not currently used
@param title: window title for the dialog
@param format_str: format of date to be returned
@param date: initial date as YYYY-MM-DD, otherwise today
@return: a tuple containing the exit code and date
@rtype: C{DialogData(int, str)}
"""
return self._run_kdialog(title, ["--calendar", title], kwargs) | python | def calendar(self, title="Choose a date", format_str="%Y-%m-%d", date="today", **kwargs):
"""
Show a calendar dialog
Usage: C{dialog.calendar_dialog(title="Choose a date", format="%Y-%m-%d", date="YYYY-MM-DD", **kwargs)}
Note: the format and date parameters are not currently used
@param title: window title for the dialog
@param format_str: format of date to be returned
@param date: initial date as YYYY-MM-DD, otherwise today
@return: a tuple containing the exit code and date
@rtype: C{DialogData(int, str)}
"""
return self._run_kdialog(title, ["--calendar", title], kwargs) | [
"def",
"calendar",
"(",
"self",
",",
"title",
"=",
"\"Choose a date\"",
",",
"format_str",
"=",
"\"%Y-%m-%d\"",
",",
"date",
"=",
"\"today\"",
",",
"*",
"*",
"kwargs",
")",
":",
"return",
"self",
".",
"_run_kdialog",
"(",
"title",
",",
"[",
"\"--calendar\"... | Show a calendar dialog
Usage: C{dialog.calendar_dialog(title="Choose a date", format="%Y-%m-%d", date="YYYY-MM-DD", **kwargs)}
Note: the format and date parameters are not currently used
@param title: window title for the dialog
@param format_str: format of date to be returned
@param date: initial date as YYYY-MM-DD, otherwise today
@return: a tuple containing the exit code and date
@rtype: C{DialogData(int, str)} | [
"Show",
"a",
"calendar",
"dialog"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/scripting.py#L453-L467 | train | 220,664 |
autokey/autokey | lib/autokey/scripting.py | Window.activate | def activate(self, title, switchDesktop=False, matchClass=False):
"""
Activate the specified window, giving it input focus
Usage: C{window.activate(title, switchDesktop=False, matchClass=False)}
If switchDesktop is False (default), the window will be moved to the current desktop
and activated. Otherwise, switch to the window's current desktop and activate it there.
@param title: window title to match against (as case-insensitive substring match)
@param switchDesktop: whether or not to switch to the window's current desktop
@param matchClass: if True, match on the window class instead of the title
"""
if switchDesktop:
args = ["-a", title]
else:
args = ["-R", title]
if matchClass:
args += ["-x"]
self._run_wmctrl(args) | python | def activate(self, title, switchDesktop=False, matchClass=False):
"""
Activate the specified window, giving it input focus
Usage: C{window.activate(title, switchDesktop=False, matchClass=False)}
If switchDesktop is False (default), the window will be moved to the current desktop
and activated. Otherwise, switch to the window's current desktop and activate it there.
@param title: window title to match against (as case-insensitive substring match)
@param switchDesktop: whether or not to switch to the window's current desktop
@param matchClass: if True, match on the window class instead of the title
"""
if switchDesktop:
args = ["-a", title]
else:
args = ["-R", title]
if matchClass:
args += ["-x"]
self._run_wmctrl(args) | [
"def",
"activate",
"(",
"self",
",",
"title",
",",
"switchDesktop",
"=",
"False",
",",
"matchClass",
"=",
"False",
")",
":",
"if",
"switchDesktop",
":",
"args",
"=",
"[",
"\"-a\"",
",",
"title",
"]",
"else",
":",
"args",
"=",
"[",
"\"-R\"",
",",
"tit... | Activate the specified window, giving it input focus
Usage: C{window.activate(title, switchDesktop=False, matchClass=False)}
If switchDesktop is False (default), the window will be moved to the current desktop
and activated. Otherwise, switch to the window's current desktop and activate it there.
@param title: window title to match against (as case-insensitive substring match)
@param switchDesktop: whether or not to switch to the window's current desktop
@param matchClass: if True, match on the window class instead of the title | [
"Activate",
"the",
"specified",
"window",
"giving",
"it",
"input",
"focus"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/scripting.py#L963-L982 | train | 220,665 |
autokey/autokey | lib/autokey/scripting.py | Window.set_property | def set_property(self, title, action, prop, matchClass=False):
"""
Set a property on the given window using the specified action
Usage: C{window.set_property(title, action, prop, matchClass=False)}
Allowable actions: C{add, remove, toggle}
Allowable properties: C{modal, sticky, maximized_vert, maximized_horz, shaded, skip_taskbar,
skip_pager, hidden, fullscreen, above}
@param title: window title to match against (as case-insensitive substring match)
@param action: one of the actions listed above
@param prop: one of the properties listed above
@param matchClass: if True, match on the window class instead of the title
"""
if matchClass:
xArgs = ["-x"]
else:
xArgs = []
self._run_wmctrl(["-r", title, "-b" + action + ',' + prop] + xArgs) | python | def set_property(self, title, action, prop, matchClass=False):
"""
Set a property on the given window using the specified action
Usage: C{window.set_property(title, action, prop, matchClass=False)}
Allowable actions: C{add, remove, toggle}
Allowable properties: C{modal, sticky, maximized_vert, maximized_horz, shaded, skip_taskbar,
skip_pager, hidden, fullscreen, above}
@param title: window title to match against (as case-insensitive substring match)
@param action: one of the actions listed above
@param prop: one of the properties listed above
@param matchClass: if True, match on the window class instead of the title
"""
if matchClass:
xArgs = ["-x"]
else:
xArgs = []
self._run_wmctrl(["-r", title, "-b" + action + ',' + prop] + xArgs) | [
"def",
"set_property",
"(",
"self",
",",
"title",
",",
"action",
",",
"prop",
",",
"matchClass",
"=",
"False",
")",
":",
"if",
"matchClass",
":",
"xArgs",
"=",
"[",
"\"-x\"",
"]",
"else",
":",
"xArgs",
"=",
"[",
"]",
"self",
".",
"_run_wmctrl",
"(",
... | Set a property on the given window using the specified action
Usage: C{window.set_property(title, action, prop, matchClass=False)}
Allowable actions: C{add, remove, toggle}
Allowable properties: C{modal, sticky, maximized_vert, maximized_horz, shaded, skip_taskbar,
skip_pager, hidden, fullscreen, above}
@param title: window title to match against (as case-insensitive substring match)
@param action: one of the actions listed above
@param prop: one of the properties listed above
@param matchClass: if True, match on the window class instead of the title | [
"Set",
"a",
"property",
"on",
"the",
"given",
"window",
"using",
"the",
"specified",
"action"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/scripting.py#L1047-L1066 | train | 220,666 |
autokey/autokey | lib/autokey/scripting.py | Engine.run_script_from_macro | def run_script_from_macro(self, args):
"""
Used internally by AutoKey for phrase macros
"""
self.__macroArgs = args["args"].split(',')
try:
self.run_script(args["name"])
except Exception as e:
self.set_return_value("{ERROR: %s}" % str(e)) | python | def run_script_from_macro(self, args):
"""
Used internally by AutoKey for phrase macros
"""
self.__macroArgs = args["args"].split(',')
try:
self.run_script(args["name"])
except Exception as e:
self.set_return_value("{ERROR: %s}" % str(e)) | [
"def",
"run_script_from_macro",
"(",
"self",
",",
"args",
")",
":",
"self",
".",
"__macroArgs",
"=",
"args",
"[",
"\"args\"",
"]",
".",
"split",
"(",
"','",
")",
"try",
":",
"self",
".",
"run_script",
"(",
"args",
"[",
"\"name\"",
"]",
")",
"except",
... | Used internally by AutoKey for phrase macros | [
"Used",
"internally",
"by",
"AutoKey",
"for",
"phrase",
"macros"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/scripting.py#L1256-L1265 | train | 220,667 |
autokey/autokey | lib/autokey/scripting_highlevel.py | move_to_pat | def move_to_pat(pat: str, offset: (float, float)=None, tolerance: int=0) -> None:
"""See help for click_on_pat"""
with tempfile.NamedTemporaryFile() as f:
subprocess.call('''
xwd -root -silent -display :0 |
convert xwd:- png:''' + f.name, shell=True)
loc = visgrep(f.name, pat, tolerance)
pat_size = get_png_dim(pat)
if offset is None:
x, y = [l + ps//2 for l, ps in zip(loc, pat_size)]
else:
x, y = [l + ps*(off/100) for off, l, ps in zip(offset, loc, pat_size)]
mouse_move(x, y) | python | def move_to_pat(pat: str, offset: (float, float)=None, tolerance: int=0) -> None:
"""See help for click_on_pat"""
with tempfile.NamedTemporaryFile() as f:
subprocess.call('''
xwd -root -silent -display :0 |
convert xwd:- png:''' + f.name, shell=True)
loc = visgrep(f.name, pat, tolerance)
pat_size = get_png_dim(pat)
if offset is None:
x, y = [l + ps//2 for l, ps in zip(loc, pat_size)]
else:
x, y = [l + ps*(off/100) for off, l, ps in zip(offset, loc, pat_size)]
mouse_move(x, y) | [
"def",
"move_to_pat",
"(",
"pat",
":",
"str",
",",
"offset",
":",
"(",
"float",
",",
"float",
")",
"=",
"None",
",",
"tolerance",
":",
"int",
"=",
"0",
")",
"->",
"None",
":",
"with",
"tempfile",
".",
"NamedTemporaryFile",
"(",
")",
"as",
"f",
":",... | See help for click_on_pat | [
"See",
"help",
"for",
"click_on_pat"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/scripting_highlevel.py#L99-L111 | train | 220,668 |
autokey/autokey | lib/autokey/scripting_highlevel.py | acknowledge_gnome_notification | def acknowledge_gnome_notification():
"""
Moves mouse pointer to the bottom center of the screen and clicks on it.
"""
x0, y0 = mouse_pos()
mouse_move(10000, 10000) # TODO: What if the screen is larger? Loop until mouse position does not change anymore?
x, y = mouse_pos()
mouse_rmove(-x/2, 0)
mouse_click(LEFT)
time.sleep(.2)
mouse_move(x0, y0) | python | def acknowledge_gnome_notification():
"""
Moves mouse pointer to the bottom center of the screen and clicks on it.
"""
x0, y0 = mouse_pos()
mouse_move(10000, 10000) # TODO: What if the screen is larger? Loop until mouse position does not change anymore?
x, y = mouse_pos()
mouse_rmove(-x/2, 0)
mouse_click(LEFT)
time.sleep(.2)
mouse_move(x0, y0) | [
"def",
"acknowledge_gnome_notification",
"(",
")",
":",
"x0",
",",
"y0",
"=",
"mouse_pos",
"(",
")",
"mouse_move",
"(",
"10000",
",",
"10000",
")",
"# TODO: What if the screen is larger? Loop until mouse position does not change anymore?",
"x",
",",
"y",
"=",
"mouse_pos... | Moves mouse pointer to the bottom center of the screen and clicks on it. | [
"Moves",
"mouse",
"pointer",
"to",
"the",
"bottom",
"center",
"of",
"the",
"screen",
"and",
"clicks",
"on",
"it",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/scripting_highlevel.py#L114-L124 | train | 220,669 |
autokey/autokey | lib/autokey/service.py | Service.calculate_extra_keys | def calculate_extra_keys(self, buffer):
"""
Determine extra keys pressed since the given buffer was built
"""
extraBs = len(self.inputStack) - len(buffer)
if extraBs > 0:
extraKeys = ''.join(self.inputStack[len(buffer)])
else:
extraBs = 0
extraKeys = ''
return extraBs, extraKeys | python | def calculate_extra_keys(self, buffer):
"""
Determine extra keys pressed since the given buffer was built
"""
extraBs = len(self.inputStack) - len(buffer)
if extraBs > 0:
extraKeys = ''.join(self.inputStack[len(buffer)])
else:
extraBs = 0
extraKeys = ''
return extraBs, extraKeys | [
"def",
"calculate_extra_keys",
"(",
"self",
",",
"buffer",
")",
":",
"extraBs",
"=",
"len",
"(",
"self",
".",
"inputStack",
")",
"-",
"len",
"(",
"buffer",
")",
"if",
"extraBs",
">",
"0",
":",
"extraKeys",
"=",
"''",
".",
"join",
"(",
"self",
".",
... | Determine extra keys pressed since the given buffer was built | [
"Determine",
"extra",
"keys",
"pressed",
"since",
"the",
"given",
"buffer",
"was",
"built"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/service.py#L244-L254 | train | 220,670 |
autokey/autokey | lib/autokey/service.py | Service.__updateStack | def __updateStack(self, key):
"""
Update the input stack in non-hotkey mode, and determine if anything
further is needed.
@return: True if further action is needed
"""
#if self.lastMenu is not None:
# if not ConfigManager.SETTINGS[MENU_TAKES_FOCUS]:
# self.app.hide_menu()
#
# self.lastMenu = None
if key == Key.ENTER:
# Special case - map Enter to \n
key = '\n'
if key == Key.TAB:
# Special case - map Tab to \t
key = '\t'
if key == Key.BACKSPACE:
if ConfigManager.SETTINGS[UNDO_USING_BACKSPACE] and self.phraseRunner.can_undo():
self.phraseRunner.undo_expansion()
else:
# handle backspace by dropping the last saved character
try:
self.inputStack.pop()
except IndexError:
# in case self.inputStack is empty
pass
return False
elif len(key) > 1:
# non-simple key
self.inputStack.clear()
self.phraseRunner.clear_last()
return False
else:
# Key is a character
self.phraseRunner.clear_last()
# if len(self.inputStack) == MAX_STACK_LENGTH, front items will removed for appending new items.
self.inputStack.append(key)
return True | python | def __updateStack(self, key):
"""
Update the input stack in non-hotkey mode, and determine if anything
further is needed.
@return: True if further action is needed
"""
#if self.lastMenu is not None:
# if not ConfigManager.SETTINGS[MENU_TAKES_FOCUS]:
# self.app.hide_menu()
#
# self.lastMenu = None
if key == Key.ENTER:
# Special case - map Enter to \n
key = '\n'
if key == Key.TAB:
# Special case - map Tab to \t
key = '\t'
if key == Key.BACKSPACE:
if ConfigManager.SETTINGS[UNDO_USING_BACKSPACE] and self.phraseRunner.can_undo():
self.phraseRunner.undo_expansion()
else:
# handle backspace by dropping the last saved character
try:
self.inputStack.pop()
except IndexError:
# in case self.inputStack is empty
pass
return False
elif len(key) > 1:
# non-simple key
self.inputStack.clear()
self.phraseRunner.clear_last()
return False
else:
# Key is a character
self.phraseRunner.clear_last()
# if len(self.inputStack) == MAX_STACK_LENGTH, front items will removed for appending new items.
self.inputStack.append(key)
return True | [
"def",
"__updateStack",
"(",
"self",
",",
"key",
")",
":",
"#if self.lastMenu is not None:",
"# if not ConfigManager.SETTINGS[MENU_TAKES_FOCUS]:",
"# self.app.hide_menu()",
"#",
"# self.lastMenu = None",
"if",
"key",
"==",
"Key",
".",
"ENTER",
":",
"# Special cas... | Update the input stack in non-hotkey mode, and determine if anything
further is needed.
@return: True if further action is needed | [
"Update",
"the",
"input",
"stack",
"in",
"non",
"-",
"hotkey",
"mode",
"and",
"determine",
"if",
"anything",
"further",
"is",
"needed",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/service.py#L256-L299 | train | 220,671 |
autokey/autokey | lib/autokey/interface.py | XInterfaceBase.__grabHotkeys | def __grabHotkeys(self):
"""
Run during startup to grab global and specific hotkeys in all open windows
"""
c = self.app.configManager
hotkeys = c.hotKeys + c.hotKeyFolders
# Grab global hotkeys in root window
for item in c.globalHotkeys:
if item.enabled:
self.__enqueue(self.__grabHotkey, item.hotKey, item.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__enqueue(self.__grabRecurse, item, self.rootWindow, False)
# Grab hotkeys without a filter in root window
for item in hotkeys:
if item.get_applicable_regex() is None:
self.__enqueue(self.__grabHotkey, item.hotKey, item.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__enqueue(self.__grabRecurse, item, self.rootWindow, False)
self.__enqueue(self.__recurseTree, self.rootWindow, hotkeys) | python | def __grabHotkeys(self):
"""
Run during startup to grab global and specific hotkeys in all open windows
"""
c = self.app.configManager
hotkeys = c.hotKeys + c.hotKeyFolders
# Grab global hotkeys in root window
for item in c.globalHotkeys:
if item.enabled:
self.__enqueue(self.__grabHotkey, item.hotKey, item.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__enqueue(self.__grabRecurse, item, self.rootWindow, False)
# Grab hotkeys without a filter in root window
for item in hotkeys:
if item.get_applicable_regex() is None:
self.__enqueue(self.__grabHotkey, item.hotKey, item.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__enqueue(self.__grabRecurse, item, self.rootWindow, False)
self.__enqueue(self.__recurseTree, self.rootWindow, hotkeys) | [
"def",
"__grabHotkeys",
"(",
"self",
")",
":",
"c",
"=",
"self",
".",
"app",
".",
"configManager",
"hotkeys",
"=",
"c",
".",
"hotKeys",
"+",
"c",
".",
"hotKeyFolders",
"# Grab global hotkeys in root window",
"for",
"item",
"in",
"c",
".",
"globalHotkeys",
":... | Run during startup to grab global and specific hotkeys in all open windows | [
"Run",
"during",
"startup",
"to",
"grab",
"global",
"and",
"specific",
"hotkeys",
"in",
"all",
"open",
"windows"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/interface.py#L353-L374 | train | 220,672 |
autokey/autokey | lib/autokey/interface.py | XInterfaceBase.__ungrabAllHotkeys | def __ungrabAllHotkeys(self):
"""
Ungrab all hotkeys in preparation for keymap change
"""
c = self.app.configManager
hotkeys = c.hotKeys + c.hotKeyFolders
# Ungrab global hotkeys in root window, recursively
for item in c.globalHotkeys:
if item.enabled:
self.__ungrabHotkey(item.hotKey, item.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__ungrabRecurse(item, self.rootWindow, False)
# Ungrab hotkeys without a filter in root window, recursively
for item in hotkeys:
if item.get_applicable_regex() is None:
self.__ungrabHotkey(item.hotKey, item.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__ungrabRecurse(item, self.rootWindow, False)
self.__recurseTreeUngrab(self.rootWindow, hotkeys) | python | def __ungrabAllHotkeys(self):
"""
Ungrab all hotkeys in preparation for keymap change
"""
c = self.app.configManager
hotkeys = c.hotKeys + c.hotKeyFolders
# Ungrab global hotkeys in root window, recursively
for item in c.globalHotkeys:
if item.enabled:
self.__ungrabHotkey(item.hotKey, item.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__ungrabRecurse(item, self.rootWindow, False)
# Ungrab hotkeys without a filter in root window, recursively
for item in hotkeys:
if item.get_applicable_regex() is None:
self.__ungrabHotkey(item.hotKey, item.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__ungrabRecurse(item, self.rootWindow, False)
self.__recurseTreeUngrab(self.rootWindow, hotkeys) | [
"def",
"__ungrabAllHotkeys",
"(",
"self",
")",
":",
"c",
"=",
"self",
".",
"app",
".",
"configManager",
"hotkeys",
"=",
"c",
".",
"hotKeys",
"+",
"c",
".",
"hotKeyFolders",
"# Ungrab global hotkeys in root window, recursively",
"for",
"item",
"in",
"c",
".",
"... | Ungrab all hotkeys in preparation for keymap change | [
"Ungrab",
"all",
"hotkeys",
"in",
"preparation",
"for",
"keymap",
"change"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/interface.py#L397-L418 | train | 220,673 |
autokey/autokey | lib/autokey/interface.py | XInterfaceBase.__grabHotkeysForWindow | def __grabHotkeysForWindow(self, window):
"""
Grab all hotkeys relevant to the window
Used when a new window is created
"""
c = self.app.configManager
hotkeys = c.hotKeys + c.hotKeyFolders
window_info = self.get_window_info(window)
for item in hotkeys:
if item.get_applicable_regex() is not None and item._should_trigger_window_title(window_info):
self.__enqueue(self.__grabHotkey, item.hotKey, item.modifiers, window)
elif self.__needsMutterWorkaround(item):
self.__enqueue(self.__grabHotkey, item.hotKey, item.modifiers, window) | python | def __grabHotkeysForWindow(self, window):
"""
Grab all hotkeys relevant to the window
Used when a new window is created
"""
c = self.app.configManager
hotkeys = c.hotKeys + c.hotKeyFolders
window_info = self.get_window_info(window)
for item in hotkeys:
if item.get_applicable_regex() is not None and item._should_trigger_window_title(window_info):
self.__enqueue(self.__grabHotkey, item.hotKey, item.modifiers, window)
elif self.__needsMutterWorkaround(item):
self.__enqueue(self.__grabHotkey, item.hotKey, item.modifiers, window) | [
"def",
"__grabHotkeysForWindow",
"(",
"self",
",",
"window",
")",
":",
"c",
"=",
"self",
".",
"app",
".",
"configManager",
"hotkeys",
"=",
"c",
".",
"hotKeys",
"+",
"c",
".",
"hotKeyFolders",
"window_info",
"=",
"self",
".",
"get_window_info",
"(",
"window... | Grab all hotkeys relevant to the window
Used when a new window is created | [
"Grab",
"all",
"hotkeys",
"relevant",
"to",
"the",
"window"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/interface.py#L441-L454 | train | 220,674 |
autokey/autokey | lib/autokey/interface.py | XInterfaceBase.__grabHotkey | def __grabHotkey(self, key, modifiers, window):
"""
Grab a specific hotkey in the given window
"""
logger.debug("Grabbing hotkey: %r %r", modifiers, key)
try:
keycode = self.__lookupKeyCode(key)
mask = 0
for mod in modifiers:
mask |= self.modMasks[mod]
window.grab_key(keycode, mask, True, X.GrabModeAsync, X.GrabModeAsync)
if Key.NUMLOCK in self.modMasks:
window.grab_key(keycode, mask|self.modMasks[Key.NUMLOCK], True, X.GrabModeAsync, X.GrabModeAsync)
if Key.CAPSLOCK in self.modMasks:
window.grab_key(keycode, mask|self.modMasks[Key.CAPSLOCK], True, X.GrabModeAsync, X.GrabModeAsync)
if Key.CAPSLOCK in self.modMasks and Key.NUMLOCK in self.modMasks:
window.grab_key(keycode, mask|self.modMasks[Key.CAPSLOCK]|self.modMasks[Key.NUMLOCK], True, X.GrabModeAsync, X.GrabModeAsync)
except Exception as e:
logger.warning("Failed to grab hotkey %r %r: %s", modifiers, key, str(e)) | python | def __grabHotkey(self, key, modifiers, window):
"""
Grab a specific hotkey in the given window
"""
logger.debug("Grabbing hotkey: %r %r", modifiers, key)
try:
keycode = self.__lookupKeyCode(key)
mask = 0
for mod in modifiers:
mask |= self.modMasks[mod]
window.grab_key(keycode, mask, True, X.GrabModeAsync, X.GrabModeAsync)
if Key.NUMLOCK in self.modMasks:
window.grab_key(keycode, mask|self.modMasks[Key.NUMLOCK], True, X.GrabModeAsync, X.GrabModeAsync)
if Key.CAPSLOCK in self.modMasks:
window.grab_key(keycode, mask|self.modMasks[Key.CAPSLOCK], True, X.GrabModeAsync, X.GrabModeAsync)
if Key.CAPSLOCK in self.modMasks and Key.NUMLOCK in self.modMasks:
window.grab_key(keycode, mask|self.modMasks[Key.CAPSLOCK]|self.modMasks[Key.NUMLOCK], True, X.GrabModeAsync, X.GrabModeAsync)
except Exception as e:
logger.warning("Failed to grab hotkey %r %r: %s", modifiers, key, str(e)) | [
"def",
"__grabHotkey",
"(",
"self",
",",
"key",
",",
"modifiers",
",",
"window",
")",
":",
"logger",
".",
"debug",
"(",
"\"Grabbing hotkey: %r %r\"",
",",
"modifiers",
",",
"key",
")",
"try",
":",
"keycode",
"=",
"self",
".",
"__lookupKeyCode",
"(",
"key",... | Grab a specific hotkey in the given window | [
"Grab",
"a",
"specific",
"hotkey",
"in",
"the",
"given",
"window"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/interface.py#L456-L479 | train | 220,675 |
autokey/autokey | lib/autokey/interface.py | XInterfaceBase.grab_hotkey | def grab_hotkey(self, item):
"""
Grab a hotkey.
If the hotkey has no filter regex, it is global and is grabbed recursively from the root window
If it has a filter regex, iterate over all children of the root and grab from matching windows
"""
if item.get_applicable_regex() is None:
self.__enqueue(self.__grabHotkey, item.hotKey, item.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__enqueue(self.__grabRecurse, item, self.rootWindow, False)
else:
self.__enqueue(self.__grabRecurse, item, self.rootWindow) | python | def grab_hotkey(self, item):
"""
Grab a hotkey.
If the hotkey has no filter regex, it is global and is grabbed recursively from the root window
If it has a filter regex, iterate over all children of the root and grab from matching windows
"""
if item.get_applicable_regex() is None:
self.__enqueue(self.__grabHotkey, item.hotKey, item.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__enqueue(self.__grabRecurse, item, self.rootWindow, False)
else:
self.__enqueue(self.__grabRecurse, item, self.rootWindow) | [
"def",
"grab_hotkey",
"(",
"self",
",",
"item",
")",
":",
"if",
"item",
".",
"get_applicable_regex",
"(",
")",
"is",
"None",
":",
"self",
".",
"__enqueue",
"(",
"self",
".",
"__grabHotkey",
",",
"item",
".",
"hotKey",
",",
"item",
".",
"modifiers",
","... | Grab a hotkey.
If the hotkey has no filter regex, it is global and is grabbed recursively from the root window
If it has a filter regex, iterate over all children of the root and grab from matching windows | [
"Grab",
"a",
"hotkey",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/interface.py#L481-L493 | train | 220,676 |
autokey/autokey | lib/autokey/interface.py | XInterfaceBase.ungrab_hotkey | def ungrab_hotkey(self, item):
"""
Ungrab a hotkey.
If the hotkey has no filter regex, it is global and is grabbed recursively from the root window
If it has a filter regex, iterate over all children of the root and ungrab from matching windows
"""
import copy
newItem = copy.copy(item)
if item.get_applicable_regex() is None:
self.__enqueue(self.__ungrabHotkey, newItem.hotKey, newItem.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__enqueue(self.__ungrabRecurse, newItem, self.rootWindow, False)
else:
self.__enqueue(self.__ungrabRecurse, newItem, self.rootWindow) | python | def ungrab_hotkey(self, item):
"""
Ungrab a hotkey.
If the hotkey has no filter regex, it is global and is grabbed recursively from the root window
If it has a filter regex, iterate over all children of the root and ungrab from matching windows
"""
import copy
newItem = copy.copy(item)
if item.get_applicable_regex() is None:
self.__enqueue(self.__ungrabHotkey, newItem.hotKey, newItem.modifiers, self.rootWindow)
if self.__needsMutterWorkaround(item):
self.__enqueue(self.__ungrabRecurse, newItem, self.rootWindow, False)
else:
self.__enqueue(self.__ungrabRecurse, newItem, self.rootWindow) | [
"def",
"ungrab_hotkey",
"(",
"self",
",",
"item",
")",
":",
"import",
"copy",
"newItem",
"=",
"copy",
".",
"copy",
"(",
"item",
")",
"if",
"item",
".",
"get_applicable_regex",
"(",
")",
"is",
"None",
":",
"self",
".",
"__enqueue",
"(",
"self",
".",
"... | Ungrab a hotkey.
If the hotkey has no filter regex, it is global and is grabbed recursively from the root window
If it has a filter regex, iterate over all children of the root and ungrab from matching windows | [
"Ungrab",
"a",
"hotkey",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/interface.py#L514-L529 | train | 220,677 |
autokey/autokey | lib/autokey/interface.py | XInterfaceBase.__ungrabHotkey | def __ungrabHotkey(self, key, modifiers, window):
"""
Ungrab a specific hotkey in the given window
"""
logger.debug("Ungrabbing hotkey: %r %r", modifiers, key)
try:
keycode = self.__lookupKeyCode(key)
mask = 0
for mod in modifiers:
mask |= self.modMasks[mod]
window.ungrab_key(keycode, mask)
if Key.NUMLOCK in self.modMasks:
window.ungrab_key(keycode, mask|self.modMasks[Key.NUMLOCK])
if Key.CAPSLOCK in self.modMasks:
window.ungrab_key(keycode, mask|self.modMasks[Key.CAPSLOCK])
if Key.CAPSLOCK in self.modMasks and Key.NUMLOCK in self.modMasks:
window.ungrab_key(keycode, mask|self.modMasks[Key.CAPSLOCK]|self.modMasks[Key.NUMLOCK])
except Exception as e:
logger.warning("Failed to ungrab hotkey %r %r: %s", modifiers, key, str(e)) | python | def __ungrabHotkey(self, key, modifiers, window):
"""
Ungrab a specific hotkey in the given window
"""
logger.debug("Ungrabbing hotkey: %r %r", modifiers, key)
try:
keycode = self.__lookupKeyCode(key)
mask = 0
for mod in modifiers:
mask |= self.modMasks[mod]
window.ungrab_key(keycode, mask)
if Key.NUMLOCK in self.modMasks:
window.ungrab_key(keycode, mask|self.modMasks[Key.NUMLOCK])
if Key.CAPSLOCK in self.modMasks:
window.ungrab_key(keycode, mask|self.modMasks[Key.CAPSLOCK])
if Key.CAPSLOCK in self.modMasks and Key.NUMLOCK in self.modMasks:
window.ungrab_key(keycode, mask|self.modMasks[Key.CAPSLOCK]|self.modMasks[Key.NUMLOCK])
except Exception as e:
logger.warning("Failed to ungrab hotkey %r %r: %s", modifiers, key, str(e)) | [
"def",
"__ungrabHotkey",
"(",
"self",
",",
"key",
",",
"modifiers",
",",
"window",
")",
":",
"logger",
".",
"debug",
"(",
"\"Ungrabbing hotkey: %r %r\"",
",",
"modifiers",
",",
"key",
")",
"try",
":",
"keycode",
"=",
"self",
".",
"__lookupKeyCode",
"(",
"k... | Ungrab a specific hotkey in the given window | [
"Ungrab",
"a",
"specific",
"hotkey",
"in",
"the",
"given",
"window"
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/interface.py#L550-L572 | train | 220,678 |
autokey/autokey | lib/autokey/interface.py | XInterfaceBase._send_string_clipboard | def _send_string_clipboard(self, string: str, paste_command: model.SendMode):
"""
Use the clipboard to send a string.
"""
backup = self.clipboard.text # Keep a backup of current content, to restore the original afterwards.
if backup is None:
logger.warning("Tried to backup the X clipboard content, but got None instead of a string.")
self.clipboard.text = string
try:
self.mediator.send_string(paste_command.value)
finally:
self.ungrab_keyboard()
# Because send_string is queued, also enqueue the clipboard restore, to keep the proper action ordering.
self.__enqueue(self._restore_clipboard_text, backup) | python | def _send_string_clipboard(self, string: str, paste_command: model.SendMode):
"""
Use the clipboard to send a string.
"""
backup = self.clipboard.text # Keep a backup of current content, to restore the original afterwards.
if backup is None:
logger.warning("Tried to backup the X clipboard content, but got None instead of a string.")
self.clipboard.text = string
try:
self.mediator.send_string(paste_command.value)
finally:
self.ungrab_keyboard()
# Because send_string is queued, also enqueue the clipboard restore, to keep the proper action ordering.
self.__enqueue(self._restore_clipboard_text, backup) | [
"def",
"_send_string_clipboard",
"(",
"self",
",",
"string",
":",
"str",
",",
"paste_command",
":",
"model",
".",
"SendMode",
")",
":",
"backup",
"=",
"self",
".",
"clipboard",
".",
"text",
"# Keep a backup of current content, to restore the original afterwards.",
"if... | Use the clipboard to send a string. | [
"Use",
"the",
"clipboard",
"to",
"send",
"a",
"string",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/interface.py#L615-L628 | train | 220,679 |
autokey/autokey | lib/autokey/interface.py | XInterfaceBase._restore_clipboard_text | def _restore_clipboard_text(self, backup: str):
"""Restore the clipboard content."""
# Pasting takes some time, so wait a bit before restoring the content. Otherwise the restore is done before
# the pasting happens, causing the backup to be pasted instead of the desired clipboard content.
time.sleep(0.2)
self.clipboard.text = backup if backup is not None else "" | python | def _restore_clipboard_text(self, backup: str):
"""Restore the clipboard content."""
# Pasting takes some time, so wait a bit before restoring the content. Otherwise the restore is done before
# the pasting happens, causing the backup to be pasted instead of the desired clipboard content.
time.sleep(0.2)
self.clipboard.text = backup if backup is not None else "" | [
"def",
"_restore_clipboard_text",
"(",
"self",
",",
"backup",
":",
"str",
")",
":",
"# Pasting takes some time, so wait a bit before restoring the content. Otherwise the restore is done before",
"# the pasting happens, causing the backup to be pasted instead of the desired clipboard content.",... | Restore the clipboard content. | [
"Restore",
"the",
"clipboard",
"content",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/interface.py#L630-L635 | train | 220,680 |
autokey/autokey | lib/autokey/interface.py | XInterfaceBase._send_string_selection | def _send_string_selection(self, string: str):
"""Use the mouse selection clipboard to send a string."""
backup = self.clipboard.selection # Keep a backup of current content, to restore the original afterwards.
if backup is None:
logger.warning("Tried to backup the X PRIMARY selection content, but got None instead of a string.")
self.clipboard.selection = string
self.__enqueue(self._paste_using_mouse_button_2)
self.__enqueue(self._restore_clipboard_selection, backup) | python | def _send_string_selection(self, string: str):
"""Use the mouse selection clipboard to send a string."""
backup = self.clipboard.selection # Keep a backup of current content, to restore the original afterwards.
if backup is None:
logger.warning("Tried to backup the X PRIMARY selection content, but got None instead of a string.")
self.clipboard.selection = string
self.__enqueue(self._paste_using_mouse_button_2)
self.__enqueue(self._restore_clipboard_selection, backup) | [
"def",
"_send_string_selection",
"(",
"self",
",",
"string",
":",
"str",
")",
":",
"backup",
"=",
"self",
".",
"clipboard",
".",
"selection",
"# Keep a backup of current content, to restore the original afterwards.",
"if",
"backup",
"is",
"None",
":",
"logger",
".",
... | Use the mouse selection clipboard to send a string. | [
"Use",
"the",
"mouse",
"selection",
"clipboard",
"to",
"send",
"a",
"string",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/interface.py#L637-L644 | train | 220,681 |
autokey/autokey | lib/autokey/interface.py | XInterfaceBase._restore_clipboard_selection | def _restore_clipboard_selection(self, backup: str):
"""Restore the selection clipboard content."""
# Pasting takes some time, so wait a bit before restoring the content. Otherwise the restore is done before
# the pasting happens, causing the backup to be pasted instead of the desired clipboard content.
# Programmatically pressing the middle mouse button seems VERY slow, so wait rather long.
# It might be a good idea to make this delay configurable. There might be systems that need even longer.
time.sleep(1)
self.clipboard.selection = backup if backup is not None else "" | python | def _restore_clipboard_selection(self, backup: str):
"""Restore the selection clipboard content."""
# Pasting takes some time, so wait a bit before restoring the content. Otherwise the restore is done before
# the pasting happens, causing the backup to be pasted instead of the desired clipboard content.
# Programmatically pressing the middle mouse button seems VERY slow, so wait rather long.
# It might be a good idea to make this delay configurable. There might be systems that need even longer.
time.sleep(1)
self.clipboard.selection = backup if backup is not None else "" | [
"def",
"_restore_clipboard_selection",
"(",
"self",
",",
"backup",
":",
"str",
")",
":",
"# Pasting takes some time, so wait a bit before restoring the content. Otherwise the restore is done before",
"# the pasting happens, causing the backup to be pasted instead of the desired clipboard conte... | Restore the selection clipboard content. | [
"Restore",
"the",
"selection",
"clipboard",
"content",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/interface.py#L646-L654 | train | 220,682 |
autokey/autokey | lib/autokey/qtui/settings/engine.py | EngineSettings.save | def save(self):
"""This function is called by the parent dialog window when the user selects to save the settings."""
if self.path is None: # Delete requested, so remove the current path from sys.path, if present
if self.config_manager.userCodeDir is not None:
sys.path.remove(self.config_manager.userCodeDir)
self.config_manager.userCodeDir = None
logger.info("Removed custom module search path from configuration and sys.path.")
else:
if self.path != self.config_manager.userCodeDir:
if self.config_manager.userCodeDir is not None:
sys.path.remove(self.config_manager.userCodeDir)
sys.path.append(self.path)
self.config_manager.userCodeDir = self.path
logger.info("Saved custom module search path and added it to sys.path: {}".format(self.path)) | python | def save(self):
"""This function is called by the parent dialog window when the user selects to save the settings."""
if self.path is None: # Delete requested, so remove the current path from sys.path, if present
if self.config_manager.userCodeDir is not None:
sys.path.remove(self.config_manager.userCodeDir)
self.config_manager.userCodeDir = None
logger.info("Removed custom module search path from configuration and sys.path.")
else:
if self.path != self.config_manager.userCodeDir:
if self.config_manager.userCodeDir is not None:
sys.path.remove(self.config_manager.userCodeDir)
sys.path.append(self.path)
self.config_manager.userCodeDir = self.path
logger.info("Saved custom module search path and added it to sys.path: {}".format(self.path)) | [
"def",
"save",
"(",
"self",
")",
":",
"if",
"self",
".",
"path",
"is",
"None",
":",
"# Delete requested, so remove the current path from sys.path, if present",
"if",
"self",
".",
"config_manager",
".",
"userCodeDir",
"is",
"not",
"None",
":",
"sys",
".",
"path",
... | This function is called by the parent dialog window when the user selects to save the settings. | [
"This",
"function",
"is",
"called",
"by",
"the",
"parent",
"dialog",
"window",
"when",
"the",
"user",
"selects",
"to",
"save",
"the",
"settings",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/settings/engine.py#L55-L69 | train | 220,683 |
autokey/autokey | lib/autokey/qtui/settings/engine.py | EngineSettings.on_browse_button_pressed | def on_browse_button_pressed(self):
"""
PyQt slot called when the user hits the "Browse" button.
Display a directory selection dialog and store the returned path.
"""
path = QFileDialog.getExistingDirectory(self.parentWidget(), "Choose a directory containing Python modules")
if path: # Non-empty means the user chose a path and clicked on OK
self.path = path
self.clear_button.setEnabled(True)
self.folder_label.setText(path)
logger.debug("User selects a custom module search path: {}".format(self.path)) | python | def on_browse_button_pressed(self):
"""
PyQt slot called when the user hits the "Browse" button.
Display a directory selection dialog and store the returned path.
"""
path = QFileDialog.getExistingDirectory(self.parentWidget(), "Choose a directory containing Python modules")
if path: # Non-empty means the user chose a path and clicked on OK
self.path = path
self.clear_button.setEnabled(True)
self.folder_label.setText(path)
logger.debug("User selects a custom module search path: {}".format(self.path)) | [
"def",
"on_browse_button_pressed",
"(",
"self",
")",
":",
"path",
"=",
"QFileDialog",
".",
"getExistingDirectory",
"(",
"self",
".",
"parentWidget",
"(",
")",
",",
"\"Choose a directory containing Python modules\"",
")",
"if",
"path",
":",
"# Non-empty means the user ch... | PyQt slot called when the user hits the "Browse" button.
Display a directory selection dialog and store the returned path. | [
"PyQt",
"slot",
"called",
"when",
"the",
"user",
"hits",
"the",
"Browse",
"button",
".",
"Display",
"a",
"directory",
"selection",
"dialog",
"and",
"store",
"the",
"returned",
"path",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/settings/engine.py#L72-L83 | train | 220,684 |
autokey/autokey | lib/autokey/qtui/settings/engine.py | EngineSettings.on_clear_button_pressed | def on_clear_button_pressed(self):
"""
PyQt slot called when the user hits the "Clear" button.
Removes any set custom module search path.
"""
self.path = None
self.clear_button.setEnabled(False)
self.folder_label.setText(self.initial_folder_label_text)
logger.debug("User selects to clear the custom module search path.") | python | def on_clear_button_pressed(self):
"""
PyQt slot called when the user hits the "Clear" button.
Removes any set custom module search path.
"""
self.path = None
self.clear_button.setEnabled(False)
self.folder_label.setText(self.initial_folder_label_text)
logger.debug("User selects to clear the custom module search path.") | [
"def",
"on_clear_button_pressed",
"(",
"self",
")",
":",
"self",
".",
"path",
"=",
"None",
"self",
".",
"clear_button",
".",
"setEnabled",
"(",
"False",
")",
"self",
".",
"folder_label",
".",
"setText",
"(",
"self",
".",
"initial_folder_label_text",
")",
"lo... | PyQt slot called when the user hits the "Clear" button.
Removes any set custom module search path. | [
"PyQt",
"slot",
"called",
"when",
"the",
"user",
"hits",
"the",
"Clear",
"button",
".",
"Removes",
"any",
"set",
"custom",
"module",
"search",
"path",
"."
] | 35decb72f286ce68cd2a1f09ace8891a520b58d1 | https://github.com/autokey/autokey/blob/35decb72f286ce68cd2a1f09ace8891a520b58d1/lib/autokey/qtui/settings/engine.py#L86-L94 | train | 220,685 |
maartenbreddels/ipyvolume | ipyvolume/examples.py | example_ylm | def example_ylm(m=0, n=2, shape=128, limits=[-4, 4], draw=True, show=True, **kwargs):
"""Show a spherical harmonic."""
import ipyvolume.pylab as p3
__, __, __, r, theta, phi = xyz(shape=shape, limits=limits, spherical=True)
radial = np.exp(-(r - 2) ** 2)
data = np.abs(scipy.special.sph_harm(m, n, theta, phi) ** 2) * radial # pylint: disable=no-member
if draw:
vol = p3.volshow(data=data, **kwargs)
if show:
p3.show()
return vol
else:
return data | python | def example_ylm(m=0, n=2, shape=128, limits=[-4, 4], draw=True, show=True, **kwargs):
"""Show a spherical harmonic."""
import ipyvolume.pylab as p3
__, __, __, r, theta, phi = xyz(shape=shape, limits=limits, spherical=True)
radial = np.exp(-(r - 2) ** 2)
data = np.abs(scipy.special.sph_harm(m, n, theta, phi) ** 2) * radial # pylint: disable=no-member
if draw:
vol = p3.volshow(data=data, **kwargs)
if show:
p3.show()
return vol
else:
return data | [
"def",
"example_ylm",
"(",
"m",
"=",
"0",
",",
"n",
"=",
"2",
",",
"shape",
"=",
"128",
",",
"limits",
"=",
"[",
"-",
"4",
",",
"4",
"]",
",",
"draw",
"=",
"True",
",",
"show",
"=",
"True",
",",
"*",
"*",
"kwargs",
")",
":",
"import",
"ipyv... | Show a spherical harmonic. | [
"Show",
"a",
"spherical",
"harmonic",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/examples.py#L55-L68 | train | 220,686 |
maartenbreddels/ipyvolume | ipyvolume/examples.py | ball | def ball(rmax=3, rmin=0, shape=128, limits=[-4, 4], draw=True, show=True, **kwargs):
"""Show a ball."""
import ipyvolume.pylab as p3
__, __, __, r, _theta, _phi = xyz(shape=shape, limits=limits, spherical=True)
data = r * 0
data[(r < rmax) & (r >= rmin)] = 0.5
if "data_min" not in kwargs:
kwargs["data_min"] = 0
if "data_max" not in kwargs:
kwargs["data_max"] = 1
data = data.T
if draw:
vol = p3.volshow(data=data, **kwargs)
if show:
p3.show()
return vol
else:
return data | python | def ball(rmax=3, rmin=0, shape=128, limits=[-4, 4], draw=True, show=True, **kwargs):
"""Show a ball."""
import ipyvolume.pylab as p3
__, __, __, r, _theta, _phi = xyz(shape=shape, limits=limits, spherical=True)
data = r * 0
data[(r < rmax) & (r >= rmin)] = 0.5
if "data_min" not in kwargs:
kwargs["data_min"] = 0
if "data_max" not in kwargs:
kwargs["data_max"] = 1
data = data.T
if draw:
vol = p3.volshow(data=data, **kwargs)
if show:
p3.show()
return vol
else:
return data | [
"def",
"ball",
"(",
"rmax",
"=",
"3",
",",
"rmin",
"=",
"0",
",",
"shape",
"=",
"128",
",",
"limits",
"=",
"[",
"-",
"4",
",",
"4",
"]",
",",
"draw",
"=",
"True",
",",
"show",
"=",
"True",
",",
"*",
"*",
"kwargs",
")",
":",
"import",
"ipyvo... | Show a ball. | [
"Show",
"a",
"ball",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/examples.py#L72-L90 | train | 220,687 |
maartenbreddels/ipyvolume | ipyvolume/examples.py | brain | def brain(
draw=True, show=True, fiducial=True, flat=True, inflated=True, subject='S1', interval=1000, uv=True, color=None
):
"""Show a human brain model.
Requirement:
$ pip install https://github.com/gallantlab/pycortex
"""
import ipyvolume as ipv
try:
import cortex
except:
warnings.warn("it seems pycortex is not installed, which is needed for this example")
raise
xlist, ylist, zlist = [], [], []
polys_list = []
def add(pts, polys):
xlist.append(pts[:, 0])
ylist.append(pts[:, 1])
zlist.append(pts[:, 2])
polys_list.append(polys)
def n(x):
return (x - x.min()) / x.ptp()
if fiducial or color is True:
pts, polys = cortex.db.get_surf('S1', 'fiducial', merge=True)
x, y, z = pts.T
r = n(x)
g = n(y)
b = n(z)
if color is True:
color = np.array([r, g, b]).T.copy()
else:
color = None
if fiducial:
add(pts, polys)
else:
if color is False:
color = None
if inflated:
add(*cortex.db.get_surf('S1', 'inflated', merge=True, nudge=True))
u = v = None
if flat or uv:
pts, polys = cortex.db.get_surf('S1', 'flat', merge=True, nudge=True)
x, y, z = pts.T
u = n(x)
v = n(y)
if flat:
add(pts, polys)
polys_list.sort(key=lambda x: len(x))
polys = polys_list[0]
if draw:
if color is None:
mesh = ipv.plot_trisurf(xlist, ylist, zlist, polys, u=u, v=v)
else:
mesh = ipv.plot_trisurf(xlist, ylist, zlist, polys, color=color, u=u, v=v)
if show:
if len(x) > 1:
ipv.animation_control(mesh, interval=interval)
ipv.squarelim()
ipv.show()
return mesh
else:
return xlist, ylist, zlist, polys | python | def brain(
draw=True, show=True, fiducial=True, flat=True, inflated=True, subject='S1', interval=1000, uv=True, color=None
):
"""Show a human brain model.
Requirement:
$ pip install https://github.com/gallantlab/pycortex
"""
import ipyvolume as ipv
try:
import cortex
except:
warnings.warn("it seems pycortex is not installed, which is needed for this example")
raise
xlist, ylist, zlist = [], [], []
polys_list = []
def add(pts, polys):
xlist.append(pts[:, 0])
ylist.append(pts[:, 1])
zlist.append(pts[:, 2])
polys_list.append(polys)
def n(x):
return (x - x.min()) / x.ptp()
if fiducial or color is True:
pts, polys = cortex.db.get_surf('S1', 'fiducial', merge=True)
x, y, z = pts.T
r = n(x)
g = n(y)
b = n(z)
if color is True:
color = np.array([r, g, b]).T.copy()
else:
color = None
if fiducial:
add(pts, polys)
else:
if color is False:
color = None
if inflated:
add(*cortex.db.get_surf('S1', 'inflated', merge=True, nudge=True))
u = v = None
if flat or uv:
pts, polys = cortex.db.get_surf('S1', 'flat', merge=True, nudge=True)
x, y, z = pts.T
u = n(x)
v = n(y)
if flat:
add(pts, polys)
polys_list.sort(key=lambda x: len(x))
polys = polys_list[0]
if draw:
if color is None:
mesh = ipv.plot_trisurf(xlist, ylist, zlist, polys, u=u, v=v)
else:
mesh = ipv.plot_trisurf(xlist, ylist, zlist, polys, color=color, u=u, v=v)
if show:
if len(x) > 1:
ipv.animation_control(mesh, interval=interval)
ipv.squarelim()
ipv.show()
return mesh
else:
return xlist, ylist, zlist, polys | [
"def",
"brain",
"(",
"draw",
"=",
"True",
",",
"show",
"=",
"True",
",",
"fiducial",
"=",
"True",
",",
"flat",
"=",
"True",
",",
"inflated",
"=",
"True",
",",
"subject",
"=",
"'S1'",
",",
"interval",
"=",
"1000",
",",
"uv",
"=",
"True",
",",
"col... | Show a human brain model.
Requirement:
$ pip install https://github.com/gallantlab/pycortex | [
"Show",
"a",
"human",
"brain",
"model",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/examples.py#L161-L229 | train | 220,688 |
maartenbreddels/ipyvolume | ipyvolume/examples.py | head | def head(draw=True, show=True, max_shape=256):
"""Show a volumetric rendering of a human male head."""
# inspired by http://graphicsrunner.blogspot.com/2009/01/volume-rendering-102-transfer-functions.html
import ipyvolume as ipv
from scipy.interpolate import interp1d
# First part is a simpler version of setting up the transfer function. Interpolation with higher order
# splines does not work well, the original must do sth different
colors = [[0.91, 0.7, 0.61, 0.0], [0.91, 0.7, 0.61, 80.0], [1.0, 1.0, 0.85, 82.0], [1.0, 1.0, 0.85, 256]]
x = np.array([k[-1] for k in colors])
rgb = np.array([k[:3] for k in colors])
N = 256
xnew = np.linspace(0, 256, N)
tf_data = np.zeros((N, 4))
kind = 'linear'
for channel in range(3):
f = interp1d(x, rgb[:, channel], kind=kind)
ynew = f(xnew)
tf_data[:, channel] = ynew
alphas = [[0, 0], [0, 40], [0.2, 60], [0.05, 63], [0, 80], [0.9, 82], [1.0, 256]]
x = np.array([k[1] * 1.0 for k in alphas])
y = np.array([k[0] * 1.0 for k in alphas])
f = interp1d(x, y, kind=kind)
ynew = f(xnew)
tf_data[:, 3] = ynew
tf = ipv.TransferFunction(rgba=tf_data.astype(np.float32))
head_data = ipv.datasets.head.fetch().data
if draw:
vol = ipv.volshow(head_data, tf=tf, max_shape=max_shape)
if show:
ipv.show()
return vol
else:
return head_data | python | def head(draw=True, show=True, max_shape=256):
"""Show a volumetric rendering of a human male head."""
# inspired by http://graphicsrunner.blogspot.com/2009/01/volume-rendering-102-transfer-functions.html
import ipyvolume as ipv
from scipy.interpolate import interp1d
# First part is a simpler version of setting up the transfer function. Interpolation with higher order
# splines does not work well, the original must do sth different
colors = [[0.91, 0.7, 0.61, 0.0], [0.91, 0.7, 0.61, 80.0], [1.0, 1.0, 0.85, 82.0], [1.0, 1.0, 0.85, 256]]
x = np.array([k[-1] for k in colors])
rgb = np.array([k[:3] for k in colors])
N = 256
xnew = np.linspace(0, 256, N)
tf_data = np.zeros((N, 4))
kind = 'linear'
for channel in range(3):
f = interp1d(x, rgb[:, channel], kind=kind)
ynew = f(xnew)
tf_data[:, channel] = ynew
alphas = [[0, 0], [0, 40], [0.2, 60], [0.05, 63], [0, 80], [0.9, 82], [1.0, 256]]
x = np.array([k[1] * 1.0 for k in alphas])
y = np.array([k[0] * 1.0 for k in alphas])
f = interp1d(x, y, kind=kind)
ynew = f(xnew)
tf_data[:, 3] = ynew
tf = ipv.TransferFunction(rgba=tf_data.astype(np.float32))
head_data = ipv.datasets.head.fetch().data
if draw:
vol = ipv.volshow(head_data, tf=tf, max_shape=max_shape)
if show:
ipv.show()
return vol
else:
return head_data | [
"def",
"head",
"(",
"draw",
"=",
"True",
",",
"show",
"=",
"True",
",",
"max_shape",
"=",
"256",
")",
":",
"# inspired by http://graphicsrunner.blogspot.com/2009/01/volume-rendering-102-transfer-functions.html",
"import",
"ipyvolume",
"as",
"ipv",
"from",
"scipy",
".",
... | Show a volumetric rendering of a human male head. | [
"Show",
"a",
"volumetric",
"rendering",
"of",
"a",
"human",
"male",
"head",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/examples.py#L232-L266 | train | 220,689 |
maartenbreddels/ipyvolume | ipyvolume/examples.py | gaussian | def gaussian(N=1000, draw=True, show=True, seed=42, color=None, marker='sphere'):
"""Show N random gaussian distributed points using a scatter plot."""
import ipyvolume as ipv
rng = np.random.RandomState(seed) # pylint: disable=no-member
x, y, z = rng.normal(size=(3, N))
if draw:
if color:
mesh = ipv.scatter(x, y, z, marker=marker, color=color)
else:
mesh = ipv.scatter(x, y, z, marker=marker)
if show:
# ipv.squarelim()
ipv.show()
return mesh
else:
return x, y, z | python | def gaussian(N=1000, draw=True, show=True, seed=42, color=None, marker='sphere'):
"""Show N random gaussian distributed points using a scatter plot."""
import ipyvolume as ipv
rng = np.random.RandomState(seed) # pylint: disable=no-member
x, y, z = rng.normal(size=(3, N))
if draw:
if color:
mesh = ipv.scatter(x, y, z, marker=marker, color=color)
else:
mesh = ipv.scatter(x, y, z, marker=marker)
if show:
# ipv.squarelim()
ipv.show()
return mesh
else:
return x, y, z | [
"def",
"gaussian",
"(",
"N",
"=",
"1000",
",",
"draw",
"=",
"True",
",",
"show",
"=",
"True",
",",
"seed",
"=",
"42",
",",
"color",
"=",
"None",
",",
"marker",
"=",
"'sphere'",
")",
":",
"import",
"ipyvolume",
"as",
"ipv",
"rng",
"=",
"np",
".",
... | Show N random gaussian distributed points using a scatter plot. | [
"Show",
"N",
"random",
"gaussian",
"distributed",
"points",
"using",
"a",
"scatter",
"plot",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/examples.py#L269-L286 | train | 220,690 |
maartenbreddels/ipyvolume | ipyvolume/pylab.py | figure | def figure(
key=None,
width=400,
height=500,
lighting=True,
controls=True,
controls_vr=False,
controls_light=False,
debug=False,
**kwargs
):
"""Create a new figure if no key is given, or return the figure associated with key.
:param key: Python object that identifies this figure
:param int width: pixel width of WebGL canvas
:param int height: .. height ..
:param bool lighting: use lighting or not
:param bool controls: show controls or not
:param bool controls_vr: show controls for VR or not
:param bool debug: show debug buttons or not
:return: :any:`Figure`
"""
if key is not None and key in current.figures:
current.figure = current.figures[key]
current.container = current.containers[key]
elif isinstance(key, ipv.Figure) and key in current.figures.values():
key_index = list(current.figures.values()).index(key)
key = list(current.figures.keys())[key_index]
current.figure = current.figures[key]
current.container = current.containers[key]
else:
current.figure = ipv.Figure(width=width, height=height, **kwargs)
current.container = ipywidgets.VBox()
current.container.children = [current.figure]
if key is None:
key = uuid.uuid4().hex
current.figures[key] = current.figure
current.containers[key] = current.container
if controls:
# stereo = ipywidgets.ToggleButton(value=current.figure.stereo, description='stereo', icon='eye')
# l1 = ipywidgets.jslink((current.figure, 'stereo'), (stereo, 'value'))
# current.container.children += (ipywidgets.HBox([stereo, ]),)
pass # stereo and fullscreen are now include in the js code (per view)
if controls_vr:
eye_separation = ipywidgets.FloatSlider(value=current.figure.eye_separation, min=-10, max=10, icon='eye')
ipywidgets.jslink((eye_separation, 'value'), (current.figure, 'eye_separation'))
current.container.children += (eye_separation,)
if controls_light:
globals()['controls_light']()
if debug:
show = ipywidgets.ToggleButtons(options=["Volume", "Back", "Front", "Coordinate"])
current.container.children += (show,)
# ipywidgets.jslink((current.figure, 'show'), (show, 'value'))
traitlets.link((current.figure, 'show'), (show, 'value'))
return current.figure | python | def figure(
key=None,
width=400,
height=500,
lighting=True,
controls=True,
controls_vr=False,
controls_light=False,
debug=False,
**kwargs
):
"""Create a new figure if no key is given, or return the figure associated with key.
:param key: Python object that identifies this figure
:param int width: pixel width of WebGL canvas
:param int height: .. height ..
:param bool lighting: use lighting or not
:param bool controls: show controls or not
:param bool controls_vr: show controls for VR or not
:param bool debug: show debug buttons or not
:return: :any:`Figure`
"""
if key is not None and key in current.figures:
current.figure = current.figures[key]
current.container = current.containers[key]
elif isinstance(key, ipv.Figure) and key in current.figures.values():
key_index = list(current.figures.values()).index(key)
key = list(current.figures.keys())[key_index]
current.figure = current.figures[key]
current.container = current.containers[key]
else:
current.figure = ipv.Figure(width=width, height=height, **kwargs)
current.container = ipywidgets.VBox()
current.container.children = [current.figure]
if key is None:
key = uuid.uuid4().hex
current.figures[key] = current.figure
current.containers[key] = current.container
if controls:
# stereo = ipywidgets.ToggleButton(value=current.figure.stereo, description='stereo', icon='eye')
# l1 = ipywidgets.jslink((current.figure, 'stereo'), (stereo, 'value'))
# current.container.children += (ipywidgets.HBox([stereo, ]),)
pass # stereo and fullscreen are now include in the js code (per view)
if controls_vr:
eye_separation = ipywidgets.FloatSlider(value=current.figure.eye_separation, min=-10, max=10, icon='eye')
ipywidgets.jslink((eye_separation, 'value'), (current.figure, 'eye_separation'))
current.container.children += (eye_separation,)
if controls_light:
globals()['controls_light']()
if debug:
show = ipywidgets.ToggleButtons(options=["Volume", "Back", "Front", "Coordinate"])
current.container.children += (show,)
# ipywidgets.jslink((current.figure, 'show'), (show, 'value'))
traitlets.link((current.figure, 'show'), (show, 'value'))
return current.figure | [
"def",
"figure",
"(",
"key",
"=",
"None",
",",
"width",
"=",
"400",
",",
"height",
"=",
"500",
",",
"lighting",
"=",
"True",
",",
"controls",
"=",
"True",
",",
"controls_vr",
"=",
"False",
",",
"controls_light",
"=",
"False",
",",
"debug",
"=",
"Fals... | Create a new figure if no key is given, or return the figure associated with key.
:param key: Python object that identifies this figure
:param int width: pixel width of WebGL canvas
:param int height: .. height ..
:param bool lighting: use lighting or not
:param bool controls: show controls or not
:param bool controls_vr: show controls for VR or not
:param bool debug: show debug buttons or not
:return: :any:`Figure` | [
"Create",
"a",
"new",
"figure",
"if",
"no",
"key",
"is",
"given",
"or",
"return",
"the",
"figure",
"associated",
"with",
"key",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/pylab.py#L168-L222 | train | 220,691 |
maartenbreddels/ipyvolume | ipyvolume/pylab.py | squarelim | def squarelim():
"""Set all axes with equal aspect ratio, such that the space is 'square'."""
fig = gcf()
xmin, xmax = fig.xlim
ymin, ymax = fig.ylim
zmin, zmax = fig.zlim
width = max([abs(xmax - xmin), abs(ymax - ymin), abs(zmax - zmin)])
xc = (xmin + xmax) / 2
yc = (ymin + ymax) / 2
zc = (zmin + zmax) / 2
xlim(xc - width / 2, xc + width / 2)
ylim(yc - width / 2, yc + width / 2)
zlim(zc - width / 2, zc + width / 2) | python | def squarelim():
"""Set all axes with equal aspect ratio, such that the space is 'square'."""
fig = gcf()
xmin, xmax = fig.xlim
ymin, ymax = fig.ylim
zmin, zmax = fig.zlim
width = max([abs(xmax - xmin), abs(ymax - ymin), abs(zmax - zmin)])
xc = (xmin + xmax) / 2
yc = (ymin + ymax) / 2
zc = (zmin + zmax) / 2
xlim(xc - width / 2, xc + width / 2)
ylim(yc - width / 2, yc + width / 2)
zlim(zc - width / 2, zc + width / 2) | [
"def",
"squarelim",
"(",
")",
":",
"fig",
"=",
"gcf",
"(",
")",
"xmin",
",",
"xmax",
"=",
"fig",
".",
"xlim",
"ymin",
",",
"ymax",
"=",
"fig",
".",
"ylim",
"zmin",
",",
"zmax",
"=",
"fig",
".",
"zlim",
"width",
"=",
"max",
"(",
"[",
"abs",
"(... | Set all axes with equal aspect ratio, such that the space is 'square'. | [
"Set",
"all",
"axes",
"with",
"equal",
"aspect",
"ratio",
"such",
"that",
"the",
"space",
"is",
"square",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/pylab.py#L290-L302 | train | 220,692 |
maartenbreddels/ipyvolume | ipyvolume/pylab.py | plot_surface | def plot_surface(x, y, z, color=default_color, wrapx=False, wrapy=False):
"""Draws a 2d surface in 3d, defined by the 2d ordered arrays x,y,z.
:param x: {x2d}
:param y: {y2d}
:param z: {z2d}
:param color: {color2d}
:param bool wrapx: when True, the x direction is assumed to wrap, and polygons are drawn between the end end begin points
:param bool wrapy: simular for the y coordinate
:return: :any:`Mesh`
"""
return plot_mesh(x, y, z, color=color, wrapx=wrapx, wrapy=wrapy, wireframe=False) | python | def plot_surface(x, y, z, color=default_color, wrapx=False, wrapy=False):
"""Draws a 2d surface in 3d, defined by the 2d ordered arrays x,y,z.
:param x: {x2d}
:param y: {y2d}
:param z: {z2d}
:param color: {color2d}
:param bool wrapx: when True, the x direction is assumed to wrap, and polygons are drawn between the end end begin points
:param bool wrapy: simular for the y coordinate
:return: :any:`Mesh`
"""
return plot_mesh(x, y, z, color=color, wrapx=wrapx, wrapy=wrapy, wireframe=False) | [
"def",
"plot_surface",
"(",
"x",
",",
"y",
",",
"z",
",",
"color",
"=",
"default_color",
",",
"wrapx",
"=",
"False",
",",
"wrapy",
"=",
"False",
")",
":",
"return",
"plot_mesh",
"(",
"x",
",",
"y",
",",
"z",
",",
"color",
"=",
"color",
",",
"wrap... | Draws a 2d surface in 3d, defined by the 2d ordered arrays x,y,z.
:param x: {x2d}
:param y: {y2d}
:param z: {z2d}
:param color: {color2d}
:param bool wrapx: when True, the x direction is assumed to wrap, and polygons are drawn between the end end begin points
:param bool wrapy: simular for the y coordinate
:return: :any:`Mesh` | [
"Draws",
"a",
"2d",
"surface",
"in",
"3d",
"defined",
"by",
"the",
"2d",
"ordered",
"arrays",
"x",
"y",
"z",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/pylab.py#L354-L365 | train | 220,693 |
maartenbreddels/ipyvolume | ipyvolume/pylab.py | plot_wireframe | def plot_wireframe(x, y, z, color=default_color, wrapx=False, wrapy=False):
"""Draws a 2d wireframe in 3d, defines by the 2d ordered arrays x,y,z.
See also :any:`ipyvolume.pylab.plot_mesh`
:param x: {x2d}
:param y: {y2d}
:param z: {z2d}
:param color: {color2d}
:param bool wrapx: when True, the x direction is assumed to wrap, and polygons are drawn between the begin and end points
:param bool wrapy: idem for y
:return: :any:`Mesh`
"""
return plot_mesh(x, y, z, color=color, wrapx=wrapx, wrapy=wrapy, wireframe=True, surface=False) | python | def plot_wireframe(x, y, z, color=default_color, wrapx=False, wrapy=False):
"""Draws a 2d wireframe in 3d, defines by the 2d ordered arrays x,y,z.
See also :any:`ipyvolume.pylab.plot_mesh`
:param x: {x2d}
:param y: {y2d}
:param z: {z2d}
:param color: {color2d}
:param bool wrapx: when True, the x direction is assumed to wrap, and polygons are drawn between the begin and end points
:param bool wrapy: idem for y
:return: :any:`Mesh`
"""
return plot_mesh(x, y, z, color=color, wrapx=wrapx, wrapy=wrapy, wireframe=True, surface=False) | [
"def",
"plot_wireframe",
"(",
"x",
",",
"y",
",",
"z",
",",
"color",
"=",
"default_color",
",",
"wrapx",
"=",
"False",
",",
"wrapy",
"=",
"False",
")",
":",
"return",
"plot_mesh",
"(",
"x",
",",
"y",
",",
"z",
",",
"color",
"=",
"color",
",",
"wr... | Draws a 2d wireframe in 3d, defines by the 2d ordered arrays x,y,z.
See also :any:`ipyvolume.pylab.plot_mesh`
:param x: {x2d}
:param y: {y2d}
:param z: {z2d}
:param color: {color2d}
:param bool wrapx: when True, the x direction is assumed to wrap, and polygons are drawn between the begin and end points
:param bool wrapy: idem for y
:return: :any:`Mesh` | [
"Draws",
"a",
"2d",
"wireframe",
"in",
"3d",
"defines",
"by",
"the",
"2d",
"ordered",
"arrays",
"x",
"y",
"z",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/pylab.py#L369-L382 | train | 220,694 |
maartenbreddels/ipyvolume | ipyvolume/pylab.py | plot | def plot(x, y, z, color=default_color, **kwargs):
"""Plot a line in 3d.
:param x: {x}
:param y: {y}
:param z: {z}
:param color: {color}
:param kwargs: extra arguments passed to the Scatter constructor
:return: :any:`Scatter`
"""
fig = gcf()
_grow_limits(x, y, z)
defaults = dict(
visible_lines=True, color_selected=None, size_selected=1, size=1, connected=True, visible_markers=False
)
kwargs = dict(defaults, **kwargs)
s = ipv.Scatter(x=x, y=y, z=z, color=color, **kwargs)
s.material.visible = False
fig.scatters = fig.scatters + [s]
return s | python | def plot(x, y, z, color=default_color, **kwargs):
"""Plot a line in 3d.
:param x: {x}
:param y: {y}
:param z: {z}
:param color: {color}
:param kwargs: extra arguments passed to the Scatter constructor
:return: :any:`Scatter`
"""
fig = gcf()
_grow_limits(x, y, z)
defaults = dict(
visible_lines=True, color_selected=None, size_selected=1, size=1, connected=True, visible_markers=False
)
kwargs = dict(defaults, **kwargs)
s = ipv.Scatter(x=x, y=y, z=z, color=color, **kwargs)
s.material.visible = False
fig.scatters = fig.scatters + [s]
return s | [
"def",
"plot",
"(",
"x",
",",
"y",
",",
"z",
",",
"color",
"=",
"default_color",
",",
"*",
"*",
"kwargs",
")",
":",
"fig",
"=",
"gcf",
"(",
")",
"_grow_limits",
"(",
"x",
",",
"y",
",",
"z",
")",
"defaults",
"=",
"dict",
"(",
"visible_lines",
"... | Plot a line in 3d.
:param x: {x}
:param y: {y}
:param z: {z}
:param color: {color}
:param kwargs: extra arguments passed to the Scatter constructor
:return: :any:`Scatter` | [
"Plot",
"a",
"line",
"in",
"3d",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/pylab.py#L480-L499 | train | 220,695 |
maartenbreddels/ipyvolume | ipyvolume/pylab.py | quiver | def quiver(
x,
y,
z,
u,
v,
w,
size=default_size * 10,
size_selected=default_size_selected * 10,
color=default_color,
color_selected=default_color_selected,
marker="arrow",
**kwargs
):
"""Create a quiver plot, which is like a scatter plot but with arrows pointing in the direction given by u, v and w.
:param x: {x}
:param y: {y}
:param z: {z}
:param u: {u_dir}
:param v: {v_dir}
:param w: {w_dir}
:param size: {size}
:param size_selected: like size, but for selected glyphs
:param color: {color}
:param color_selected: like color, but for selected glyphs
:param marker: (currently only 'arrow' would make sense)
:param kwargs: extra arguments passed on to the Scatter constructor
:return: :any:`Scatter`
"""
fig = gcf()
_grow_limits(x, y, z)
if 'vx' in kwargs or 'vy' in kwargs or 'vz' in kwargs:
raise KeyError('Please use u, v, w instead of vx, vy, vz')
s = ipv.Scatter(
x=x,
y=y,
z=z,
vx=u,
vy=v,
vz=w,
color=color,
size=size,
color_selected=color_selected,
size_selected=size_selected,
geo=marker,
**kwargs
)
fig.scatters = fig.scatters + [s]
return s | python | def quiver(
x,
y,
z,
u,
v,
w,
size=default_size * 10,
size_selected=default_size_selected * 10,
color=default_color,
color_selected=default_color_selected,
marker="arrow",
**kwargs
):
"""Create a quiver plot, which is like a scatter plot but with arrows pointing in the direction given by u, v and w.
:param x: {x}
:param y: {y}
:param z: {z}
:param u: {u_dir}
:param v: {v_dir}
:param w: {w_dir}
:param size: {size}
:param size_selected: like size, but for selected glyphs
:param color: {color}
:param color_selected: like color, but for selected glyphs
:param marker: (currently only 'arrow' would make sense)
:param kwargs: extra arguments passed on to the Scatter constructor
:return: :any:`Scatter`
"""
fig = gcf()
_grow_limits(x, y, z)
if 'vx' in kwargs or 'vy' in kwargs or 'vz' in kwargs:
raise KeyError('Please use u, v, w instead of vx, vy, vz')
s = ipv.Scatter(
x=x,
y=y,
z=z,
vx=u,
vy=v,
vz=w,
color=color,
size=size,
color_selected=color_selected,
size_selected=size_selected,
geo=marker,
**kwargs
)
fig.scatters = fig.scatters + [s]
return s | [
"def",
"quiver",
"(",
"x",
",",
"y",
",",
"z",
",",
"u",
",",
"v",
",",
"w",
",",
"size",
"=",
"default_size",
"*",
"10",
",",
"size_selected",
"=",
"default_size_selected",
"*",
"10",
",",
"color",
"=",
"default_color",
",",
"color_selected",
"=",
"... | Create a quiver plot, which is like a scatter plot but with arrows pointing in the direction given by u, v and w.
:param x: {x}
:param y: {y}
:param z: {z}
:param u: {u_dir}
:param v: {v_dir}
:param w: {w_dir}
:param size: {size}
:param size_selected: like size, but for selected glyphs
:param color: {color}
:param color_selected: like color, but for selected glyphs
:param marker: (currently only 'arrow' would make sense)
:param kwargs: extra arguments passed on to the Scatter constructor
:return: :any:`Scatter` | [
"Create",
"a",
"quiver",
"plot",
"which",
"is",
"like",
"a",
"scatter",
"plot",
"but",
"with",
"arrows",
"pointing",
"in",
"the",
"direction",
"given",
"by",
"u",
"v",
"and",
"w",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/pylab.py#L551-L600 | train | 220,696 |
maartenbreddels/ipyvolume | ipyvolume/pylab.py | animation_control | def animation_control(object, sequence_length=None, add=True, interval=200):
"""Animate scatter, quiver or mesh by adding a slider and play button.
:param object: :any:`Scatter` or :any:`Mesh` object (having an sequence_index property), or a list of these to
control multiple.
:param sequence_length: If sequence_length is None we try try our best to figure out, in case we do it badly,
you can tell us what it should be. Should be equal to the S in the shape of the numpy arrays as for instance
documented in :any:`scatter` or :any:`plot_mesh`.
:param add: if True, add the widgets to the container, else return a HBox with the slider and play button. Useful when you
want to customise the layout of the widgets yourself.
:param interval: interval in msec between each frame
:return: If add is False, if returns the ipywidgets.HBox object containing the controls
"""
if isinstance(object, (list, tuple)):
objects = object
else:
objects = [object]
del object
if sequence_length is None:
# get all non-None arrays
sequence_lengths = []
for object in objects:
sequence_lengths_previous = list(sequence_lengths)
values = [getattr(object, name) for name in "x y z vx vy vz".split() if hasattr(object, name)]
values = [k for k in values if k is not None]
# sort them such that the higest dim is first
values.sort(key=lambda key: -len(key.shape))
try:
sequence_length = values[0].shape[0] # assume this defines the sequence length
if isinstance(object, ipv.Mesh): # for a mesh, it does not make sense to have less than 1 dimension
if len(values[0].shape) >= 2: # if just 1d, it is most likely not an animation
sequence_lengths.append(sequence_length)
else:
sequence_lengths.append(sequence_length)
except IndexError: # scalars get ignored
pass
if hasattr(object, 'color'):
color = object.color
if color is not None:
shape = color.shape
if len(shape) == 3: # would be the case for for (frame, point_index, color_index)
sequence_lengths.append(shape[0])
# TODO: maybe support arrays of string type of form (frame, point_index)
if len(sequence_lengths) == len(sequence_lengths_previous):
raise ValueError('no frame dimension found for object: {}'.format(object))
sequence_length = max(sequence_lengths)
fig = gcf()
fig.animation = interval
fig.animation_exponent = 1.0
play = ipywidgets.Play(min=0, max=sequence_length - 1, interval=interval, value=0, step=1)
slider = ipywidgets.FloatSlider(min=0, max=play.max, step=1)
ipywidgets.jslink((play, 'value'), (slider, 'value'))
for object in objects:
ipywidgets.jslink((slider, 'value'), (object, 'sequence_index'))
control = ipywidgets.HBox([play, slider])
if add:
current.container.children += (control,)
else:
return control | python | def animation_control(object, sequence_length=None, add=True, interval=200):
"""Animate scatter, quiver or mesh by adding a slider and play button.
:param object: :any:`Scatter` or :any:`Mesh` object (having an sequence_index property), or a list of these to
control multiple.
:param sequence_length: If sequence_length is None we try try our best to figure out, in case we do it badly,
you can tell us what it should be. Should be equal to the S in the shape of the numpy arrays as for instance
documented in :any:`scatter` or :any:`plot_mesh`.
:param add: if True, add the widgets to the container, else return a HBox with the slider and play button. Useful when you
want to customise the layout of the widgets yourself.
:param interval: interval in msec between each frame
:return: If add is False, if returns the ipywidgets.HBox object containing the controls
"""
if isinstance(object, (list, tuple)):
objects = object
else:
objects = [object]
del object
if sequence_length is None:
# get all non-None arrays
sequence_lengths = []
for object in objects:
sequence_lengths_previous = list(sequence_lengths)
values = [getattr(object, name) for name in "x y z vx vy vz".split() if hasattr(object, name)]
values = [k for k in values if k is not None]
# sort them such that the higest dim is first
values.sort(key=lambda key: -len(key.shape))
try:
sequence_length = values[0].shape[0] # assume this defines the sequence length
if isinstance(object, ipv.Mesh): # for a mesh, it does not make sense to have less than 1 dimension
if len(values[0].shape) >= 2: # if just 1d, it is most likely not an animation
sequence_lengths.append(sequence_length)
else:
sequence_lengths.append(sequence_length)
except IndexError: # scalars get ignored
pass
if hasattr(object, 'color'):
color = object.color
if color is not None:
shape = color.shape
if len(shape) == 3: # would be the case for for (frame, point_index, color_index)
sequence_lengths.append(shape[0])
# TODO: maybe support arrays of string type of form (frame, point_index)
if len(sequence_lengths) == len(sequence_lengths_previous):
raise ValueError('no frame dimension found for object: {}'.format(object))
sequence_length = max(sequence_lengths)
fig = gcf()
fig.animation = interval
fig.animation_exponent = 1.0
play = ipywidgets.Play(min=0, max=sequence_length - 1, interval=interval, value=0, step=1)
slider = ipywidgets.FloatSlider(min=0, max=play.max, step=1)
ipywidgets.jslink((play, 'value'), (slider, 'value'))
for object in objects:
ipywidgets.jslink((slider, 'value'), (object, 'sequence_index'))
control = ipywidgets.HBox([play, slider])
if add:
current.container.children += (control,)
else:
return control | [
"def",
"animation_control",
"(",
"object",
",",
"sequence_length",
"=",
"None",
",",
"add",
"=",
"True",
",",
"interval",
"=",
"200",
")",
":",
"if",
"isinstance",
"(",
"object",
",",
"(",
"list",
",",
"tuple",
")",
")",
":",
"objects",
"=",
"object",
... | Animate scatter, quiver or mesh by adding a slider and play button.
:param object: :any:`Scatter` or :any:`Mesh` object (having an sequence_index property), or a list of these to
control multiple.
:param sequence_length: If sequence_length is None we try try our best to figure out, in case we do it badly,
you can tell us what it should be. Should be equal to the S in the shape of the numpy arrays as for instance
documented in :any:`scatter` or :any:`plot_mesh`.
:param add: if True, add the widgets to the container, else return a HBox with the slider and play button. Useful when you
want to customise the layout of the widgets yourself.
:param interval: interval in msec between each frame
:return: If add is False, if returns the ipywidgets.HBox object containing the controls | [
"Animate",
"scatter",
"quiver",
"or",
"mesh",
"by",
"adding",
"a",
"slider",
"and",
"play",
"button",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/pylab.py#L617-L675 | train | 220,697 |
maartenbreddels/ipyvolume | ipyvolume/pylab.py | transfer_function | def transfer_function(
level=[0.1, 0.5, 0.9], opacity=[0.01, 0.05, 0.1], level_width=0.1, controls=True, max_opacity=0.2
):
"""Create a transfer function, see volshow."""
tf_kwargs = {}
# level, opacity and widths can be scalars
try:
level[0]
except:
level = [level]
try:
opacity[0]
except:
opacity = [opacity] * 3
try:
level_width[0]
except:
level_width = [level_width] * 3
# clip off lists
min_length = min(len(level), len(level_width), len(opacity))
level = list(level[:min_length])
opacity = list(opacity[:min_length])
level_width = list(level_width[:min_length])
# append with zeros
while len(level) < 3:
level.append(0)
while len(opacity) < 3:
opacity.append(0)
while len(level_width) < 3:
level_width.append(0)
for i in range(1, 4):
tf_kwargs["level" + str(i)] = level[i - 1]
tf_kwargs["opacity" + str(i)] = opacity[i - 1]
tf_kwargs["width" + str(i)] = level_width[i - 1]
tf = ipv.TransferFunctionWidgetJs3(**tf_kwargs)
gcf() # make sure a current container/figure exists
if controls:
current.container.children = (tf.control(max_opacity=max_opacity),) + current.container.children
return tf | python | def transfer_function(
level=[0.1, 0.5, 0.9], opacity=[0.01, 0.05, 0.1], level_width=0.1, controls=True, max_opacity=0.2
):
"""Create a transfer function, see volshow."""
tf_kwargs = {}
# level, opacity and widths can be scalars
try:
level[0]
except:
level = [level]
try:
opacity[0]
except:
opacity = [opacity] * 3
try:
level_width[0]
except:
level_width = [level_width] * 3
# clip off lists
min_length = min(len(level), len(level_width), len(opacity))
level = list(level[:min_length])
opacity = list(opacity[:min_length])
level_width = list(level_width[:min_length])
# append with zeros
while len(level) < 3:
level.append(0)
while len(opacity) < 3:
opacity.append(0)
while len(level_width) < 3:
level_width.append(0)
for i in range(1, 4):
tf_kwargs["level" + str(i)] = level[i - 1]
tf_kwargs["opacity" + str(i)] = opacity[i - 1]
tf_kwargs["width" + str(i)] = level_width[i - 1]
tf = ipv.TransferFunctionWidgetJs3(**tf_kwargs)
gcf() # make sure a current container/figure exists
if controls:
current.container.children = (tf.control(max_opacity=max_opacity),) + current.container.children
return tf | [
"def",
"transfer_function",
"(",
"level",
"=",
"[",
"0.1",
",",
"0.5",
",",
"0.9",
"]",
",",
"opacity",
"=",
"[",
"0.01",
",",
"0.05",
",",
"0.1",
"]",
",",
"level_width",
"=",
"0.1",
",",
"controls",
"=",
"True",
",",
"max_opacity",
"=",
"0.2",
")... | Create a transfer function, see volshow. | [
"Create",
"a",
"transfer",
"function",
"see",
"volshow",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/pylab.py#L684-L722 | train | 220,698 |
maartenbreddels/ipyvolume | ipyvolume/pylab.py | save | def save(
filepath,
makedirs=True,
title=u'IPyVolume Widget',
all_states=False,
offline=False,
scripts_path='js',
drop_defaults=False,
template_options=(("extra_script_head", ""), ("body_pre", ""), ("body_post", "")),
devmode=False,
offline_cors=False,
):
"""Save the current container to a HTML file.
By default the HTML file is not standalone and requires an internet connection to fetch a few javascript
libraries. Use offline=True to download these and make the HTML file work without an internet connection.
:param str filepath: The file to write the HTML output to.
:param bool makedirs: whether to make directories in the filename path, if they do not already exist
:param str title: title for the html page
:param bool all_states: if True, the state of all widgets know to the widget manager is included, else only those in widgets
:param bool offline: if True, use local urls for required js/css packages and download all js/css required packages
(if not already available), such that the html can be viewed with no internet connection
:param str scripts_path: the folder to save required js/css packages to (relative to the filepath)
:param bool drop_defaults: Whether to drop default values from the widget states
:param template_options: list or dict of additional template options
:param bool devmode: if True, attempt to get index.js from local js/dist folder
:param bool offline_cors: if True, sets crossorigin attribute of script tags to anonymous
"""
ipyvolume.embed.embed_html(
filepath,
current.container,
makedirs=makedirs,
title=title,
all_states=all_states,
offline=offline,
scripts_path=scripts_path,
drop_defaults=drop_defaults,
template_options=template_options,
devmode=devmode,
offline_cors=offline_cors,
) | python | def save(
filepath,
makedirs=True,
title=u'IPyVolume Widget',
all_states=False,
offline=False,
scripts_path='js',
drop_defaults=False,
template_options=(("extra_script_head", ""), ("body_pre", ""), ("body_post", "")),
devmode=False,
offline_cors=False,
):
"""Save the current container to a HTML file.
By default the HTML file is not standalone and requires an internet connection to fetch a few javascript
libraries. Use offline=True to download these and make the HTML file work without an internet connection.
:param str filepath: The file to write the HTML output to.
:param bool makedirs: whether to make directories in the filename path, if they do not already exist
:param str title: title for the html page
:param bool all_states: if True, the state of all widgets know to the widget manager is included, else only those in widgets
:param bool offline: if True, use local urls for required js/css packages and download all js/css required packages
(if not already available), such that the html can be viewed with no internet connection
:param str scripts_path: the folder to save required js/css packages to (relative to the filepath)
:param bool drop_defaults: Whether to drop default values from the widget states
:param template_options: list or dict of additional template options
:param bool devmode: if True, attempt to get index.js from local js/dist folder
:param bool offline_cors: if True, sets crossorigin attribute of script tags to anonymous
"""
ipyvolume.embed.embed_html(
filepath,
current.container,
makedirs=makedirs,
title=title,
all_states=all_states,
offline=offline,
scripts_path=scripts_path,
drop_defaults=drop_defaults,
template_options=template_options,
devmode=devmode,
offline_cors=offline_cors,
) | [
"def",
"save",
"(",
"filepath",
",",
"makedirs",
"=",
"True",
",",
"title",
"=",
"u'IPyVolume Widget'",
",",
"all_states",
"=",
"False",
",",
"offline",
"=",
"False",
",",
"scripts_path",
"=",
"'js'",
",",
"drop_defaults",
"=",
"False",
",",
"template_option... | Save the current container to a HTML file.
By default the HTML file is not standalone and requires an internet connection to fetch a few javascript
libraries. Use offline=True to download these and make the HTML file work without an internet connection.
:param str filepath: The file to write the HTML output to.
:param bool makedirs: whether to make directories in the filename path, if they do not already exist
:param str title: title for the html page
:param bool all_states: if True, the state of all widgets know to the widget manager is included, else only those in widgets
:param bool offline: if True, use local urls for required js/css packages and download all js/css required packages
(if not already available), such that the html can be viewed with no internet connection
:param str scripts_path: the folder to save required js/css packages to (relative to the filepath)
:param bool drop_defaults: Whether to drop default values from the widget states
:param template_options: list or dict of additional template options
:param bool devmode: if True, attempt to get index.js from local js/dist folder
:param bool offline_cors: if True, sets crossorigin attribute of script tags to anonymous | [
"Save",
"the",
"current",
"container",
"to",
"a",
"HTML",
"file",
"."
] | e68b72852b61276f8e6793bc8811f5b2432a155f | https://github.com/maartenbreddels/ipyvolume/blob/e68b72852b61276f8e6793bc8811f5b2432a155f/ipyvolume/pylab.py#L888-L930 | train | 220,699 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.