partition stringclasses 3
values | func_name stringlengths 1 134 | docstring stringlengths 1 46.9k | path stringlengths 4 223 | original_string stringlengths 75 104k | code stringlengths 75 104k | docstring_tokens listlengths 1 1.97k | repo stringlengths 7 55 | language stringclasses 1
value | url stringlengths 87 315 | code_tokens listlengths 19 28.4k | sha stringlengths 40 40 |
|---|---|---|---|---|---|---|---|---|---|---|---|
test | GramFuzzer.add_to_cat_group | Associate the provided rule definition name ``def_name`` with the
category group ``cat_group`` in the category ``cat``.
:param str cat: The category the rule definition was declared in
:param str cat_group: The group within the category the rule belongs to
:param str def_name: The name ... | gramfuzz/gramfuzz/__init__.py | def add_to_cat_group(self, cat, cat_group, def_name):
"""Associate the provided rule definition name ``def_name`` with the
category group ``cat_group`` in the category ``cat``.
:param str cat: The category the rule definition was declared in
:param str cat_group: The group within the ca... | def add_to_cat_group(self, cat, cat_group, def_name):
"""Associate the provided rule definition name ``def_name`` with the
category group ``cat_group`` in the category ``cat``.
:param str cat: The category the rule definition was declared in
:param str cat_group: The group within the ca... | [
"Associate",
"the",
"provided",
"rule",
"definition",
"name",
"def_name",
"with",
"the",
"category",
"group",
"cat_group",
"in",
"the",
"category",
"cat",
"."
] | mseclab/PyJFuzz | python | https://github.com/mseclab/PyJFuzz/blob/f777067076f62c9ab74ffea6e90fd54402b7a1b4/gramfuzz/gramfuzz/__init__.py#L350-L358 | [
"def",
"add_to_cat_group",
"(",
"self",
",",
"cat",
",",
"cat_group",
",",
"def_name",
")",
":",
"self",
".",
"cat_groups",
".",
"setdefault",
"(",
"cat",
",",
"{",
"}",
")",
".",
"setdefault",
"(",
"cat_group",
",",
"deque",
"(",
")",
")",
".",
"app... | f777067076f62c9ab74ffea6e90fd54402b7a1b4 |
test | GramFuzzer.get_ref | Return one of the rules in the category ``cat`` with the name
``refname``. If multiple rule defintions exist for the defintion name
``refname``, use :any:`gramfuzz.rand` to choose a rule at random.
:param str cat: The category to look for the rule in.
:param str refname: The name of the... | gramfuzz/gramfuzz/__init__.py | def get_ref(self, cat, refname):
"""Return one of the rules in the category ``cat`` with the name
``refname``. If multiple rule defintions exist for the defintion name
``refname``, use :any:`gramfuzz.rand` to choose a rule at random.
:param str cat: The category to look for the rule in.... | def get_ref(self, cat, refname):
"""Return one of the rules in the category ``cat`` with the name
``refname``. If multiple rule defintions exist for the defintion name
``refname``, use :any:`gramfuzz.rand` to choose a rule at random.
:param str cat: The category to look for the rule in.... | [
"Return",
"one",
"of",
"the",
"rules",
"in",
"the",
"category",
"cat",
"with",
"the",
"name",
"refname",
".",
"If",
"multiple",
"rule",
"defintions",
"exist",
"for",
"the",
"defintion",
"name",
"refname",
"use",
":",
"any",
":",
"gramfuzz",
".",
"rand",
... | mseclab/PyJFuzz | python | https://github.com/mseclab/PyJFuzz/blob/f777067076f62c9ab74ffea6e90fd54402b7a1b4/gramfuzz/gramfuzz/__init__.py#L360-L379 | [
"def",
"get_ref",
"(",
"self",
",",
"cat",
",",
"refname",
")",
":",
"if",
"cat",
"not",
"in",
"self",
".",
"defs",
":",
"raise",
"errors",
".",
"GramFuzzError",
"(",
"\"referenced definition category ({!r}) not defined\"",
".",
"format",
"(",
"cat",
")",
")... | f777067076f62c9ab74ffea6e90fd54402b7a1b4 |
test | GramFuzzer.gen | Generate ``num`` rules from category ``cat``, optionally specifying
preferred category groups ``preferred`` that should be preferred at
probability ``preferred_ratio`` over other randomly-chosen rule definitions.
:param int num: The number of rules to generate
:param str cat: The name o... | gramfuzz/gramfuzz/__init__.py | def gen(self, num, cat=None, cat_group=None, preferred=None, preferred_ratio=0.5, max_recursion=None, auto_process=True):
"""Generate ``num`` rules from category ``cat``, optionally specifying
preferred category groups ``preferred`` that should be preferred at
probability ``preferred_ratio`` ove... | def gen(self, num, cat=None, cat_group=None, preferred=None, preferred_ratio=0.5, max_recursion=None, auto_process=True):
"""Generate ``num`` rules from category ``cat``, optionally specifying
preferred category groups ``preferred`` that should be preferred at
probability ``preferred_ratio`` ove... | [
"Generate",
"num",
"rules",
"from",
"category",
"cat",
"optionally",
"specifying",
"preferred",
"category",
"groups",
"preferred",
"that",
"should",
"be",
"preferred",
"at",
"probability",
"preferred_ratio",
"over",
"other",
"randomly",
"-",
"chosen",
"rule",
"defin... | mseclab/PyJFuzz | python | https://github.com/mseclab/PyJFuzz/blob/f777067076f62c9ab74ffea6e90fd54402b7a1b4/gramfuzz/gramfuzz/__init__.py#L382-L492 | [
"def",
"gen",
"(",
"self",
",",
"num",
",",
"cat",
"=",
"None",
",",
"cat_group",
"=",
"None",
",",
"preferred",
"=",
"None",
",",
"preferred_ratio",
"=",
"0.5",
",",
"max_recursion",
"=",
"None",
",",
"auto_process",
"=",
"True",
")",
":",
"import",
... | f777067076f62c9ab74ffea6e90fd54402b7a1b4 |
test | GramFuzzer.post_revert | Commit any staged rule definition changes (rule generation went
smoothly). | gramfuzz/gramfuzz/__init__.py | def post_revert(self, cat, res, total_num, num, info):
"""Commit any staged rule definition changes (rule generation went
smoothly).
"""
if self._staged_defs is None:
return
for cat,def_name,def_value in self._staged_defs:
self.defs.setdefault(cat, {}).set... | def post_revert(self, cat, res, total_num, num, info):
"""Commit any staged rule definition changes (rule generation went
smoothly).
"""
if self._staged_defs is None:
return
for cat,def_name,def_value in self._staged_defs:
self.defs.setdefault(cat, {}).set... | [
"Commit",
"any",
"staged",
"rule",
"definition",
"changes",
"(",
"rule",
"generation",
"went",
"smoothly",
")",
"."
] | mseclab/PyJFuzz | python | https://github.com/mseclab/PyJFuzz/blob/f777067076f62c9ab74ffea6e90fd54402b7a1b4/gramfuzz/gramfuzz/__init__.py#L499-L507 | [
"def",
"post_revert",
"(",
"self",
",",
"cat",
",",
"res",
",",
"total_num",
",",
"num",
",",
"info",
")",
":",
"if",
"self",
".",
"_staged_defs",
"is",
"None",
":",
"return",
"for",
"cat",
",",
"def_name",
",",
"def_value",
"in",
"self",
".",
"_stag... | f777067076f62c9ab74ffea6e90fd54402b7a1b4 |
test | PJFFactory.fuzz_elements | Fuzz all elements inside the object | pyjfuzz/core/pjf_factory.py | def fuzz_elements(self, element):
"""
Fuzz all elements inside the object
"""
try:
if type(element) == dict:
tmp_element = {}
for key in element:
if len(self.config.parameters) > 0:
if self.config.exc... | def fuzz_elements(self, element):
"""
Fuzz all elements inside the object
"""
try:
if type(element) == dict:
tmp_element = {}
for key in element:
if len(self.config.parameters) > 0:
if self.config.exc... | [
"Fuzz",
"all",
"elements",
"inside",
"the",
"object"
] | mseclab/PyJFuzz | python | https://github.com/mseclab/PyJFuzz/blob/f777067076f62c9ab74ffea6e90fd54402b7a1b4/pyjfuzz/core/pjf_factory.py#L129-L171 | [
"def",
"fuzz_elements",
"(",
"self",
",",
"element",
")",
":",
"try",
":",
"if",
"type",
"(",
"element",
")",
"==",
"dict",
":",
"tmp_element",
"=",
"{",
"}",
"for",
"key",
"in",
"element",
":",
"if",
"len",
"(",
"self",
".",
"config",
".",
"parame... | f777067076f62c9ab74ffea6e90fd54402b7a1b4 |
test | PJFFactory.fuzzed | Get a printable fuzzed object | pyjfuzz/core/pjf_factory.py | def fuzzed(self):
"""
Get a printable fuzzed object
"""
try:
if self.config.strong_fuzz:
fuzzer = PJFMutators(self.config)
if self.config.url_encode:
if sys.version_info >= (3, 0):
return urllib.parse... | def fuzzed(self):
"""
Get a printable fuzzed object
"""
try:
if self.config.strong_fuzz:
fuzzer = PJFMutators(self.config)
if self.config.url_encode:
if sys.version_info >= (3, 0):
return urllib.parse... | [
"Get",
"a",
"printable",
"fuzzed",
"object"
] | mseclab/PyJFuzz | python | https://github.com/mseclab/PyJFuzz/blob/f777067076f62c9ab74ffea6e90fd54402b7a1b4/pyjfuzz/core/pjf_factory.py#L180-L206 | [
"def",
"fuzzed",
"(",
"self",
")",
":",
"try",
":",
"if",
"self",
".",
"config",
".",
"strong_fuzz",
":",
"fuzzer",
"=",
"PJFMutators",
"(",
"self",
".",
"config",
")",
"if",
"self",
".",
"config",
".",
"url_encode",
":",
"if",
"sys",
".",
"version_i... | f777067076f62c9ab74ffea6e90fd54402b7a1b4 |
test | PJFFactory.get_fuzzed | Return the fuzzed object | pyjfuzz/core/pjf_factory.py | def get_fuzzed(self, indent=False, utf8=False):
"""
Return the fuzzed object
"""
try:
if "array" in self.json:
return self.fuzz_elements(dict(self.json))["array"]
else:
return self.fuzz_elements(dict(self.json))
except Excep... | def get_fuzzed(self, indent=False, utf8=False):
"""
Return the fuzzed object
"""
try:
if "array" in self.json:
return self.fuzz_elements(dict(self.json))["array"]
else:
return self.fuzz_elements(dict(self.json))
except Excep... | [
"Return",
"the",
"fuzzed",
"object"
] | mseclab/PyJFuzz | python | https://github.com/mseclab/PyJFuzz/blob/f777067076f62c9ab74ffea6e90fd54402b7a1b4/pyjfuzz/core/pjf_factory.py#L209-L219 | [
"def",
"get_fuzzed",
"(",
"self",
",",
"indent",
"=",
"False",
",",
"utf8",
"=",
"False",
")",
":",
"try",
":",
"if",
"\"array\"",
"in",
"self",
".",
"json",
":",
"return",
"self",
".",
"fuzz_elements",
"(",
"dict",
"(",
"self",
".",
"json",
")",
"... | f777067076f62c9ab74ffea6e90fd54402b7a1b4 |
test | PJFDecorators.mutate_object_decorate | Mutate a generic object based on type | pyjfuzz/core/pjf_decoretors.py | def mutate_object_decorate(self, func):
"""
Mutate a generic object based on type
"""
def mutate():
obj = func()
return self.Mutators.get_mutator(obj, type(obj))
return mutate | def mutate_object_decorate(self, func):
"""
Mutate a generic object based on type
"""
def mutate():
obj = func()
return self.Mutators.get_mutator(obj, type(obj))
return mutate | [
"Mutate",
"a",
"generic",
"object",
"based",
"on",
"type"
] | mseclab/PyJFuzz | python | https://github.com/mseclab/PyJFuzz/blob/f777067076f62c9ab74ffea6e90fd54402b7a1b4/pyjfuzz/core/pjf_decoretors.py#L34-L41 | [
"def",
"mutate_object_decorate",
"(",
"self",
",",
"func",
")",
":",
"def",
"mutate",
"(",
")",
":",
"obj",
"=",
"func",
"(",
")",
"return",
"self",
".",
"Mutators",
".",
"get_mutator",
"(",
"obj",
",",
"type",
"(",
"obj",
")",
")",
"return",
"mutate... | f777067076f62c9ab74ffea6e90fd54402b7a1b4 |
test | Config.rewrite_redis_url | \
if REDIS_SERVER is just an ip address, then we try to translate it to
redis_url, redis://REDIS_SERVER so that it doesn't try to connect to
localhost while you try to connect to another server
:return: | singlebeat/beat.py | def rewrite_redis_url(self):
"""\
if REDIS_SERVER is just an ip address, then we try to translate it to
redis_url, redis://REDIS_SERVER so that it doesn't try to connect to
localhost while you try to connect to another server
:return:
"""
if self.REDIS_SERVER.star... | def rewrite_redis_url(self):
"""\
if REDIS_SERVER is just an ip address, then we try to translate it to
redis_url, redis://REDIS_SERVER so that it doesn't try to connect to
localhost while you try to connect to another server
:return:
"""
if self.REDIS_SERVER.star... | [
"\\",
"if",
"REDIS_SERVER",
"is",
"just",
"an",
"ip",
"address",
"then",
"we",
"try",
"to",
"translate",
"it",
"to",
"redis_url",
"redis",
":",
"//",
"REDIS_SERVER",
"so",
"that",
"it",
"doesn",
"t",
"try",
"to",
"connect",
"to",
"localhost",
"while",
"y... | ybrs/single-beat | python | https://github.com/ybrs/single-beat/blob/d036b62d2531710dfd806e9dc2a8d67c77616082/singlebeat/beat.py#L60-L71 | [
"def",
"rewrite_redis_url",
"(",
"self",
")",
":",
"if",
"self",
".",
"REDIS_SERVER",
".",
"startswith",
"(",
"'unix://'",
")",
"or",
"self",
".",
"REDIS_SERVER",
".",
"startswith",
"(",
"'redis://'",
")",
"or",
"self",
".",
"REDIS_SERVER",
".",
"startswith"... | d036b62d2531710dfd806e9dc2a8d67c77616082 |
test | Config.get_host_identifier | \
we try to return IPADDR:PID form to identify where any singlebeat instance is
running.
:return: | singlebeat/beat.py | def get_host_identifier(self):
"""\
we try to return IPADDR:PID form to identify where any singlebeat instance is
running.
:return:
"""
if self._host_identifier:
return self._host_identifier
local_ip_addr = self.get_redis().connection_pool\
... | def get_host_identifier(self):
"""\
we try to return IPADDR:PID form to identify where any singlebeat instance is
running.
:return:
"""
if self._host_identifier:
return self._host_identifier
local_ip_addr = self.get_redis().connection_pool\
... | [
"\\",
"we",
"try",
"to",
"return",
"IPADDR",
":",
"PID",
"form",
"to",
"identify",
"where",
"any",
"singlebeat",
"instance",
"is",
"running",
"."
] | ybrs/single-beat | python | https://github.com/ybrs/single-beat/blob/d036b62d2531710dfd806e9dc2a8d67c77616082/singlebeat/beat.py#L89-L101 | [
"def",
"get_host_identifier",
"(",
"self",
")",
":",
"if",
"self",
".",
"_host_identifier",
":",
"return",
"self",
".",
"_host_identifier",
"local_ip_addr",
"=",
"self",
".",
"get_redis",
"(",
")",
".",
"connection_pool",
".",
"get_connection",
"(",
"'ping'",
... | d036b62d2531710dfd806e9dc2a8d67c77616082 |
test | Process.sigterm_handler | When we get term signal
if we are waiting and got a sigterm, we just exit.
if we have a child running, we pass the signal first to the child
then we exit.
:param signum:
:param frame:
:return: | singlebeat/beat.py | def sigterm_handler(self, signum, frame):
""" When we get term signal
if we are waiting and got a sigterm, we just exit.
if we have a child running, we pass the signal first to the child
then we exit.
:param signum:
:param frame:
:return:
"""
asse... | def sigterm_handler(self, signum, frame):
""" When we get term signal
if we are waiting and got a sigterm, we just exit.
if we have a child running, we pass the signal first to the child
then we exit.
:param signum:
:param frame:
:return:
"""
asse... | [
"When",
"we",
"get",
"term",
"signal",
"if",
"we",
"are",
"waiting",
"and",
"got",
"a",
"sigterm",
"we",
"just",
"exit",
".",
"if",
"we",
"have",
"a",
"child",
"running",
"we",
"pass",
"the",
"signal",
"first",
"to",
"the",
"child",
"then",
"we",
"ex... | ybrs/single-beat | python | https://github.com/ybrs/single-beat/blob/d036b62d2531710dfd806e9dc2a8d67c77616082/singlebeat/beat.py#L259-L278 | [
"def",
"sigterm_handler",
"(",
"self",
",",
"signum",
",",
"frame",
")",
":",
"assert",
"(",
"self",
".",
"state",
"in",
"(",
"'WAITING'",
",",
"'RUNNING'",
",",
"'PAUSED'",
")",
")",
"logger",
".",
"debug",
"(",
"\"our state %s\"",
",",
"self",
".",
"... | d036b62d2531710dfd806e9dc2a8d67c77616082 |
test | Process.cli_command_quit | \
kills the child and exits | singlebeat/beat.py | def cli_command_quit(self, msg):
"""\
kills the child and exits
"""
if self.state == State.RUNNING and self.sprocess and self.sprocess.proc:
self.sprocess.proc.kill()
else:
sys.exit(0) | def cli_command_quit(self, msg):
"""\
kills the child and exits
"""
if self.state == State.RUNNING and self.sprocess and self.sprocess.proc:
self.sprocess.proc.kill()
else:
sys.exit(0) | [
"\\",
"kills",
"the",
"child",
"and",
"exits"
] | ybrs/single-beat | python | https://github.com/ybrs/single-beat/blob/d036b62d2531710dfd806e9dc2a8d67c77616082/singlebeat/beat.py#L318-L325 | [
"def",
"cli_command_quit",
"(",
"self",
",",
"msg",
")",
":",
"if",
"self",
".",
"state",
"==",
"State",
".",
"RUNNING",
"and",
"self",
".",
"sprocess",
"and",
"self",
".",
"sprocess",
".",
"proc",
":",
"self",
".",
"sprocess",
".",
"proc",
".",
"kil... | d036b62d2531710dfd806e9dc2a8d67c77616082 |
test | Process.cli_command_pause | \
if we have a running child we kill it and set our state to paused
if we don't have a running child, we set our state to paused
this will pause all the nodes in single-beat cluster
its useful when you deploy some code and don't want your child to spawn
randomly
:param ... | singlebeat/beat.py | def cli_command_pause(self, msg):
"""\
if we have a running child we kill it and set our state to paused
if we don't have a running child, we set our state to paused
this will pause all the nodes in single-beat cluster
its useful when you deploy some code and don't want your chi... | def cli_command_pause(self, msg):
"""\
if we have a running child we kill it and set our state to paused
if we don't have a running child, we set our state to paused
this will pause all the nodes in single-beat cluster
its useful when you deploy some code and don't want your chi... | [
"\\",
"if",
"we",
"have",
"a",
"running",
"child",
"we",
"kill",
"it",
"and",
"set",
"our",
"state",
"to",
"paused",
"if",
"we",
"don",
"t",
"have",
"a",
"running",
"child",
"we",
"set",
"our",
"state",
"to",
"paused",
"this",
"will",
"pause",
"all",... | ybrs/single-beat | python | https://github.com/ybrs/single-beat/blob/d036b62d2531710dfd806e9dc2a8d67c77616082/singlebeat/beat.py#L327-L346 | [
"def",
"cli_command_pause",
"(",
"self",
",",
"msg",
")",
":",
"info",
"=",
"''",
"if",
"self",
".",
"state",
"==",
"State",
".",
"RUNNING",
"and",
"self",
".",
"sprocess",
"and",
"self",
".",
"sprocess",
".",
"proc",
":",
"self",
".",
"sprocess",
".... | d036b62d2531710dfd806e9dc2a8d67c77616082 |
test | Process.cli_command_resume | \
sets state to waiting - so we resume spawning children | singlebeat/beat.py | def cli_command_resume(self, msg):
"""\
sets state to waiting - so we resume spawning children
"""
if self.state == State.PAUSED:
self.state = State.WAITING | def cli_command_resume(self, msg):
"""\
sets state to waiting - so we resume spawning children
"""
if self.state == State.PAUSED:
self.state = State.WAITING | [
"\\",
"sets",
"state",
"to",
"waiting",
"-",
"so",
"we",
"resume",
"spawning",
"children"
] | ybrs/single-beat | python | https://github.com/ybrs/single-beat/blob/d036b62d2531710dfd806e9dc2a8d67c77616082/singlebeat/beat.py#L348-L353 | [
"def",
"cli_command_resume",
"(",
"self",
",",
"msg",
")",
":",
"if",
"self",
".",
"state",
"==",
"State",
".",
"PAUSED",
":",
"self",
".",
"state",
"=",
"State",
".",
"WAITING"
] | d036b62d2531710dfd806e9dc2a8d67c77616082 |
test | Process.cli_command_stop | \
stops the running child process - if its running
it will re-spawn in any single-beat node after sometime
:param msg:
:return: | singlebeat/beat.py | def cli_command_stop(self, msg):
"""\
stops the running child process - if its running
it will re-spawn in any single-beat node after sometime
:param msg:
:return:
"""
info = ''
if self.state == State.RUNNING and self.sprocess and self.sprocess.proc:
... | def cli_command_stop(self, msg):
"""\
stops the running child process - if its running
it will re-spawn in any single-beat node after sometime
:param msg:
:return:
"""
info = ''
if self.state == State.RUNNING and self.sprocess and self.sprocess.proc:
... | [
"\\",
"stops",
"the",
"running",
"child",
"process",
"-",
"if",
"its",
"running",
"it",
"will",
"re",
"-",
"spawn",
"in",
"any",
"single",
"-",
"beat",
"node",
"after",
"sometime"
] | ybrs/single-beat | python | https://github.com/ybrs/single-beat/blob/d036b62d2531710dfd806e9dc2a8d67c77616082/singlebeat/beat.py#L355-L370 | [
"def",
"cli_command_stop",
"(",
"self",
",",
"msg",
")",
":",
"info",
"=",
"''",
"if",
"self",
".",
"state",
"==",
"State",
".",
"RUNNING",
"and",
"self",
".",
"sprocess",
"and",
"self",
".",
"sprocess",
".",
"proc",
":",
"self",
".",
"state",
"=",
... | d036b62d2531710dfd806e9dc2a8d67c77616082 |
test | Process.cli_command_restart | \
restart the subprocess
i. we set our state to RESTARTING - on restarting we still send heartbeat
ii. we kill the subprocess
iii. we start again
iv. if its started we set our state to RUNNING, else we set it to WAITING
:param msg:
:return: | singlebeat/beat.py | def cli_command_restart(self, msg):
"""\
restart the subprocess
i. we set our state to RESTARTING - on restarting we still send heartbeat
ii. we kill the subprocess
iii. we start again
iv. if its started we set our state to RUNNING, else we set it to WAITING
:par... | def cli_command_restart(self, msg):
"""\
restart the subprocess
i. we set our state to RESTARTING - on restarting we still send heartbeat
ii. we kill the subprocess
iii. we start again
iv. if its started we set our state to RUNNING, else we set it to WAITING
:par... | [
"\\",
"restart",
"the",
"subprocess",
"i",
".",
"we",
"set",
"our",
"state",
"to",
"RESTARTING",
"-",
"on",
"restarting",
"we",
"still",
"send",
"heartbeat",
"ii",
".",
"we",
"kill",
"the",
"subprocess",
"iii",
".",
"we",
"start",
"again",
"iv",
".",
"... | ybrs/single-beat | python | https://github.com/ybrs/single-beat/blob/d036b62d2531710dfd806e9dc2a8d67c77616082/singlebeat/beat.py#L372-L390 | [
"def",
"cli_command_restart",
"(",
"self",
",",
"msg",
")",
":",
"info",
"=",
"''",
"if",
"self",
".",
"state",
"==",
"State",
".",
"RUNNING",
"and",
"self",
".",
"sprocess",
"and",
"self",
".",
"sprocess",
".",
"proc",
":",
"self",
".",
"state",
"="... | d036b62d2531710dfd806e9dc2a8d67c77616082 |
test | Skype.getEvents | Retrieve a list of events since the last poll. Multiple calls may be needed to retrieve all events.
If no events occur, the API will block for up to 30 seconds, after which an empty list is returned. As soon as
an event is received in this time, it is returned immediately.
Returns:
... | skpy/main.py | def getEvents(self):
"""
Retrieve a list of events since the last poll. Multiple calls may be needed to retrieve all events.
If no events occur, the API will block for up to 30 seconds, after which an empty list is returned. As soon as
an event is received in this time, it is returned... | def getEvents(self):
"""
Retrieve a list of events since the last poll. Multiple calls may be needed to retrieve all events.
If no events occur, the API will block for up to 30 seconds, after which an empty list is returned. As soon as
an event is received in this time, it is returned... | [
"Retrieve",
"a",
"list",
"of",
"events",
"since",
"the",
"last",
"poll",
".",
"Multiple",
"calls",
"may",
"be",
"needed",
"to",
"retrieve",
"all",
"events",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/main.py#L94-L107 | [
"def",
"getEvents",
"(",
"self",
")",
":",
"events",
"=",
"[",
"]",
"for",
"json",
"in",
"self",
".",
"conn",
".",
"endpoints",
"[",
"\"self\"",
"]",
".",
"getEvents",
"(",
")",
":",
"events",
".",
"append",
"(",
"SkypeEvent",
".",
"fromRaw",
"(",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | Skype.setPresence | Set the current user's presence on the network. Supports :attr:`.Status.Online`, :attr:`.Status.Busy` or
:attr:`.Status.Hidden` (shown as :attr:`.Status.Offline` to others).
Args:
status (.Status): new availability to display to contacts | skpy/main.py | def setPresence(self, status=SkypeUtils.Status.Online):
"""
Set the current user's presence on the network. Supports :attr:`.Status.Online`, :attr:`.Status.Busy` or
:attr:`.Status.Hidden` (shown as :attr:`.Status.Offline` to others).
Args:
status (.Status): new availability... | def setPresence(self, status=SkypeUtils.Status.Online):
"""
Set the current user's presence on the network. Supports :attr:`.Status.Online`, :attr:`.Status.Busy` or
:attr:`.Status.Hidden` (shown as :attr:`.Status.Offline` to others).
Args:
status (.Status): new availability... | [
"Set",
"the",
"current",
"user",
"s",
"presence",
"on",
"the",
"network",
".",
"Supports",
":",
"attr",
":",
".",
"Status",
".",
"Online",
":",
"attr",
":",
".",
"Status",
".",
"Busy",
"or",
":",
"attr",
":",
".",
"Status",
".",
"Hidden",
"(",
"sho... | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/main.py#L109-L118 | [
"def",
"setPresence",
"(",
"self",
",",
"status",
"=",
"SkypeUtils",
".",
"Status",
".",
"Online",
")",
":",
"self",
".",
"conn",
"(",
"\"PUT\"",
",",
"\"{0}/users/ME/presenceDocs/messagingService\"",
".",
"format",
"(",
"self",
".",
"conn",
".",
"msgsHost",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | Skype.setMood | Update the activity message for the current user.
Args:
mood (str): new mood message | skpy/main.py | def setMood(self, mood):
"""
Update the activity message for the current user.
Args:
mood (str): new mood message
"""
self.conn("POST", "{0}/users/{1}/profile/partial".format(SkypeConnection.API_USER, self.userId),
auth=SkypeConnection.Auth.SkypeTok... | def setMood(self, mood):
"""
Update the activity message for the current user.
Args:
mood (str): new mood message
"""
self.conn("POST", "{0}/users/{1}/profile/partial".format(SkypeConnection.API_USER, self.userId),
auth=SkypeConnection.Auth.SkypeTok... | [
"Update",
"the",
"activity",
"message",
"for",
"the",
"current",
"user",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/main.py#L120-L129 | [
"def",
"setMood",
"(",
"self",
",",
"mood",
")",
":",
"self",
".",
"conn",
"(",
"\"POST\"",
",",
"\"{0}/users/{1}/profile/partial\"",
".",
"format",
"(",
"SkypeConnection",
".",
"API_USER",
",",
"self",
".",
"userId",
")",
",",
"auth",
"=",
"SkypeConnection"... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | Skype.setAvatar | Update the profile picture for the current user.
Args:
image (file): a file-like object to read the image from | skpy/main.py | def setAvatar(self, image):
"""
Update the profile picture for the current user.
Args:
image (file): a file-like object to read the image from
"""
self.conn("PUT", "{0}/users/{1}/profile/avatar".format(SkypeConnection.API_USER, self.userId),
auth=Sk... | def setAvatar(self, image):
"""
Update the profile picture for the current user.
Args:
image (file): a file-like object to read the image from
"""
self.conn("PUT", "{0}/users/{1}/profile/avatar".format(SkypeConnection.API_USER, self.userId),
auth=Sk... | [
"Update",
"the",
"profile",
"picture",
"for",
"the",
"current",
"user",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/main.py#L131-L139 | [
"def",
"setAvatar",
"(",
"self",
",",
"image",
")",
":",
"self",
".",
"conn",
"(",
"\"PUT\"",
",",
"\"{0}/users/{1}/profile/avatar\"",
".",
"format",
"(",
"SkypeConnection",
".",
"API_USER",
",",
"self",
".",
"userId",
")",
",",
"auth",
"=",
"SkypeConnection... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | Skype.getUrlMeta | Retrieve various metadata associated with a URL, as seen by Skype.
Args:
url (str): address to ping for info
Returns:
dict: metadata for the website queried | skpy/main.py | def getUrlMeta(self, url):
"""
Retrieve various metadata associated with a URL, as seen by Skype.
Args:
url (str): address to ping for info
Returns:
dict: metadata for the website queried
"""
return self.conn("GET", SkypeConnection.API_URL, param... | def getUrlMeta(self, url):
"""
Retrieve various metadata associated with a URL, as seen by Skype.
Args:
url (str): address to ping for info
Returns:
dict: metadata for the website queried
"""
return self.conn("GET", SkypeConnection.API_URL, param... | [
"Retrieve",
"various",
"metadata",
"associated",
"with",
"a",
"URL",
"as",
"seen",
"by",
"Skype",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/main.py#L141-L152 | [
"def",
"getUrlMeta",
"(",
"self",
",",
"url",
")",
":",
"return",
"self",
".",
"conn",
"(",
"\"GET\"",
",",
"SkypeConnection",
".",
"API_URL",
",",
"params",
"=",
"{",
"\"url\"",
":",
"url",
"}",
",",
"auth",
"=",
"SkypeConnection",
".",
"Auth",
".",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeEventLoop.cycle | Request one batch of events from Skype, calling :meth:`onEvent` with each event in turn.
Subclasses may override this method to alter loop functionality. | skpy/main.py | def cycle(self):
"""
Request one batch of events from Skype, calling :meth:`onEvent` with each event in turn.
Subclasses may override this method to alter loop functionality.
"""
try:
events = self.getEvents()
except requests.ConnectionError:
retu... | def cycle(self):
"""
Request one batch of events from Skype, calling :meth:`onEvent` with each event in turn.
Subclasses may override this method to alter loop functionality.
"""
try:
events = self.getEvents()
except requests.ConnectionError:
retu... | [
"Request",
"one",
"batch",
"of",
"events",
"from",
"Skype",
"calling",
":",
"meth",
":",
"onEvent",
"with",
"each",
"event",
"in",
"turn",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/main.py#L185-L198 | [
"def",
"cycle",
"(",
"self",
")",
":",
"try",
":",
"events",
"=",
"self",
".",
"getEvents",
"(",
")",
"except",
"requests",
".",
"ConnectionError",
":",
"return",
"for",
"event",
"in",
"events",
":",
"self",
".",
"onEvent",
"(",
"event",
")",
"if",
"... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeSettings.syncFlags | Update the cached list of all enabled flags, and store it in the :attr:`flags` attribute. | skpy/main.py | def syncFlags(self):
"""
Update the cached list of all enabled flags, and store it in the :attr:`flags` attribute.
"""
self.flags = set(self.skype.conn("GET", SkypeConnection.API_FLAGS,
auth=SkypeConnection.Auth.SkypeToken).json()) | def syncFlags(self):
"""
Update the cached list of all enabled flags, and store it in the :attr:`flags` attribute.
"""
self.flags = set(self.skype.conn("GET", SkypeConnection.API_FLAGS,
auth=SkypeConnection.Auth.SkypeToken).json()) | [
"Update",
"the",
"cached",
"list",
"of",
"all",
"enabled",
"flags",
"and",
"store",
"it",
"in",
"the",
":",
"attr",
":",
"flags",
"attribute",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/main.py#L282-L287 | [
"def",
"syncFlags",
"(",
"self",
")",
":",
"self",
".",
"flags",
"=",
"set",
"(",
"self",
".",
"skype",
".",
"conn",
"(",
"\"GET\"",
",",
"SkypeConnection",
".",
"API_FLAGS",
",",
"auth",
"=",
"SkypeConnection",
".",
"Auth",
".",
"SkypeToken",
")",
"."... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeContacts.contact | Retrieve all details for a specific contact, including fields such as birthday and mood.
Args:
id (str): user identifier to lookup
Returns:
SkypeContact: resulting contact object | skpy/user.py | def contact(self, id):
"""
Retrieve all details for a specific contact, including fields such as birthday and mood.
Args:
id (str): user identifier to lookup
Returns:
SkypeContact: resulting contact object
"""
try:
json = self.skype.c... | def contact(self, id):
"""
Retrieve all details for a specific contact, including fields such as birthday and mood.
Args:
id (str): user identifier to lookup
Returns:
SkypeContact: resulting contact object
"""
try:
json = self.skype.c... | [
"Retrieve",
"all",
"details",
"for",
"a",
"specific",
"contact",
"including",
"fields",
"such",
"as",
"birthday",
"and",
"mood",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/user.py#L388-L409 | [
"def",
"contact",
"(",
"self",
",",
"id",
")",
":",
"try",
":",
"json",
"=",
"self",
".",
"skype",
".",
"conn",
"(",
"\"POST\"",
",",
"\"{0}/users/batch/profiles\"",
".",
"format",
"(",
"SkypeConnection",
".",
"API_USER",
")",
",",
"json",
"=",
"{",
"\... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeContacts.user | Retrieve public information about a user.
Args:
id (str): user identifier to lookup
Returns:
SkypeUser: resulting user object | skpy/user.py | def user(self, id):
"""
Retrieve public information about a user.
Args:
id (str): user identifier to lookup
Returns:
SkypeUser: resulting user object
"""
json = self.skype.conn("POST", "{0}/batch/profiles".format(SkypeConnection.API_PROFILE),
... | def user(self, id):
"""
Retrieve public information about a user.
Args:
id (str): user identifier to lookup
Returns:
SkypeUser: resulting user object
"""
json = self.skype.conn("POST", "{0}/batch/profiles".format(SkypeConnection.API_PROFILE),
... | [
"Retrieve",
"public",
"information",
"about",
"a",
"user",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/user.py#L411-L426 | [
"def",
"user",
"(",
"self",
",",
"id",
")",
":",
"json",
"=",
"self",
".",
"skype",
".",
"conn",
"(",
"\"POST\"",
",",
"\"{0}/batch/profiles\"",
".",
"format",
"(",
"SkypeConnection",
".",
"API_PROFILE",
")",
",",
"auth",
"=",
"SkypeConnection",
".",
"Au... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeContacts.bots | Retrieve a list of all known bots.
Returns:
SkypeBotUser list: resulting bot user objects | skpy/user.py | def bots(self):
"""
Retrieve a list of all known bots.
Returns:
SkypeBotUser list: resulting bot user objects
"""
json = self.skype.conn("GET", "{0}/agents".format(SkypeConnection.API_BOT),
auth=SkypeConnection.Auth.SkypeToken).json().g... | def bots(self):
"""
Retrieve a list of all known bots.
Returns:
SkypeBotUser list: resulting bot user objects
"""
json = self.skype.conn("GET", "{0}/agents".format(SkypeConnection.API_BOT),
auth=SkypeConnection.Auth.SkypeToken).json().g... | [
"Retrieve",
"a",
"list",
"of",
"all",
"known",
"bots",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/user.py#L429-L438 | [
"def",
"bots",
"(",
"self",
")",
":",
"json",
"=",
"self",
".",
"skype",
".",
"conn",
"(",
"\"GET\"",
",",
"\"{0}/agents\"",
".",
"format",
"(",
"SkypeConnection",
".",
"API_BOT",
")",
",",
"auth",
"=",
"SkypeConnection",
".",
"Auth",
".",
"SkypeToken",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeContacts.bot | Retrieve a single bot.
Args:
id (str): UUID or username of the bot
Returns:
SkypeBotUser: resulting bot user object | skpy/user.py | def bot(self, id):
"""
Retrieve a single bot.
Args:
id (str): UUID or username of the bot
Returns:
SkypeBotUser: resulting bot user object
"""
json = self.skype.conn("GET", "{0}/agents".format(SkypeConnection.API_BOT), params={"agentId": id},
... | def bot(self, id):
"""
Retrieve a single bot.
Args:
id (str): UUID or username of the bot
Returns:
SkypeBotUser: resulting bot user object
"""
json = self.skype.conn("GET", "{0}/agents".format(SkypeConnection.API_BOT), params={"agentId": id},
... | [
"Retrieve",
"a",
"single",
"bot",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/user.py#L440-L452 | [
"def",
"bot",
"(",
"self",
",",
"id",
")",
":",
"json",
"=",
"self",
".",
"skype",
".",
"conn",
"(",
"\"GET\"",
",",
"\"{0}/agents\"",
".",
"format",
"(",
"SkypeConnection",
".",
"API_BOT",
")",
",",
"params",
"=",
"{",
"\"agentId\"",
":",
"id",
"}",... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeContacts.search | Search the Skype Directory for a user.
Args:
query (str): name to search for
Returns:
SkypeUser list: collection of possible results | skpy/user.py | def search(self, query):
"""
Search the Skype Directory for a user.
Args:
query (str): name to search for
Returns:
SkypeUser list: collection of possible results
"""
results = self.skype.conn("GET", SkypeConnection.API_DIRECTORY,
... | def search(self, query):
"""
Search the Skype Directory for a user.
Args:
query (str): name to search for
Returns:
SkypeUser list: collection of possible results
"""
results = self.skype.conn("GET", SkypeConnection.API_DIRECTORY,
... | [
"Search",
"the",
"Skype",
"Directory",
"for",
"a",
"user",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/user.py#L455-L468 | [
"def",
"search",
"(",
"self",
",",
"query",
")",
":",
"results",
"=",
"self",
".",
"skype",
".",
"conn",
"(",
"\"GET\"",
",",
"SkypeConnection",
".",
"API_DIRECTORY",
",",
"auth",
"=",
"SkypeConnection",
".",
"Auth",
".",
"SkypeToken",
",",
"params",
"="... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeContacts.requests | Retrieve any pending contact requests.
Returns:
:class:`SkypeRequest` list: collection of requests | skpy/user.py | def requests(self):
"""
Retrieve any pending contact requests.
Returns:
:class:`SkypeRequest` list: collection of requests
"""
requests = []
for json in self.skype.conn("GET", "{0}/users/{1}/invites"
.format(SkypeCon... | def requests(self):
"""
Retrieve any pending contact requests.
Returns:
:class:`SkypeRequest` list: collection of requests
"""
requests = []
for json in self.skype.conn("GET", "{0}/users/{1}/invites"
.format(SkypeCon... | [
"Retrieve",
"any",
"pending",
"contact",
"requests",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/user.py#L470-L485 | [
"def",
"requests",
"(",
"self",
")",
":",
"requests",
"=",
"[",
"]",
"for",
"json",
"in",
"self",
".",
"skype",
".",
"conn",
"(",
"\"GET\"",
",",
"\"{0}/users/{1}/invites\"",
".",
"format",
"(",
"SkypeConnection",
".",
"API_CONTACTS",
",",
"self",
".",
"... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeObj.fromRaw | Create a new instance based on the raw properties of an API response.
This can be overridden to automatically create subclass instances based on the raw content.
Args:
skype (Skype): parent Skype instance
raw (dict): raw object, as provided by the API
Returns:
... | skpy/core.py | def fromRaw(cls, skype=None, raw={}):
"""
Create a new instance based on the raw properties of an API response.
This can be overridden to automatically create subclass instances based on the raw content.
Args:
skype (Skype): parent Skype instance
raw (dict): raw... | def fromRaw(cls, skype=None, raw={}):
"""
Create a new instance based on the raw properties of an API response.
This can be overridden to automatically create subclass instances based on the raw content.
Args:
skype (Skype): parent Skype instance
raw (dict): raw... | [
"Create",
"a",
"new",
"instance",
"based",
"on",
"the",
"raw",
"properties",
"of",
"an",
"API",
"response",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/core.py#L48-L61 | [
"def",
"fromRaw",
"(",
"cls",
",",
"skype",
"=",
"None",
",",
"raw",
"=",
"{",
"}",
")",
":",
"return",
"cls",
"(",
"skype",
",",
"raw",
",",
"*",
"*",
"cls",
".",
"rawToFields",
"(",
"raw",
")",
")"
] | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeObj.merge | Copy properties from other into self, skipping ``None`` values. Also merges the raw data.
Args:
other (SkypeObj): second object to copy fields from | skpy/core.py | def merge(self, other):
"""
Copy properties from other into self, skipping ``None`` values. Also merges the raw data.
Args:
other (SkypeObj): second object to copy fields from
"""
for attr in self.attrs:
if not getattr(other, attr, None) is None:
... | def merge(self, other):
"""
Copy properties from other into self, skipping ``None`` values. Also merges the raw data.
Args:
other (SkypeObj): second object to copy fields from
"""
for attr in self.attrs:
if not getattr(other, attr, None) is None:
... | [
"Copy",
"properties",
"from",
"other",
"into",
"self",
"skipping",
"None",
"values",
".",
"Also",
"merges",
"the",
"raw",
"data",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/core.py#L63-L76 | [
"def",
"merge",
"(",
"self",
",",
"other",
")",
":",
"for",
"attr",
"in",
"self",
".",
"attrs",
":",
"if",
"not",
"getattr",
"(",
"other",
",",
"attr",
",",
"None",
")",
"is",
"None",
":",
"setattr",
"(",
"self",
",",
"attr",
",",
"getattr",
"(",... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeObjs.merge | Add a given object to the cache, or update an existing entry to include more fields.
Args:
obj (SkypeObj): object to add to the cache | skpy/core.py | def merge(self, obj):
"""
Add a given object to the cache, or update an existing entry to include more fields.
Args:
obj (SkypeObj): object to add to the cache
"""
if obj.id in self.cache:
self.cache[obj.id].merge(obj)
else:
self.cache... | def merge(self, obj):
"""
Add a given object to the cache, or update an existing entry to include more fields.
Args:
obj (SkypeObj): object to add to the cache
"""
if obj.id in self.cache:
self.cache[obj.id].merge(obj)
else:
self.cache... | [
"Add",
"a",
"given",
"object",
"to",
"the",
"cache",
"or",
"update",
"an",
"existing",
"entry",
"to",
"include",
"more",
"fields",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/core.py#L155-L166 | [
"def",
"merge",
"(",
"self",
",",
"obj",
")",
":",
"if",
"obj",
".",
"id",
"in",
"self",
".",
"cache",
":",
"self",
".",
"cache",
"[",
"obj",
".",
"id",
"]",
".",
"merge",
"(",
"obj",
")",
"else",
":",
"self",
".",
"cache",
"[",
"obj",
".",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.handle | Method decorator: if a given status code is received, re-authenticate and try again.
Args:
codes (int list): status codes to respond to
regToken (bool): whether to try retrieving a new token on error
Returns:
method: decorator function, ready to apply to other metho... | skpy/conn.py | def handle(*codes, **kwargs):
"""
Method decorator: if a given status code is received, re-authenticate and try again.
Args:
codes (int list): status codes to respond to
regToken (bool): whether to try retrieving a new token on error
Returns:
method:... | def handle(*codes, **kwargs):
"""
Method decorator: if a given status code is received, re-authenticate and try again.
Args:
codes (int list): status codes to respond to
regToken (bool): whether to try retrieving a new token on error
Returns:
method:... | [
"Method",
"decorator",
":",
"if",
"a",
"given",
"status",
"code",
"is",
"received",
"re",
"-",
"authenticate",
"and",
"try",
"again",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L59-L89 | [
"def",
"handle",
"(",
"*",
"codes",
",",
"*",
"*",
"kwargs",
")",
":",
"regToken",
"=",
"kwargs",
".",
"get",
"(",
"\"regToken\"",
",",
"False",
")",
"subscribe",
"=",
"kwargs",
".",
"get",
"(",
"\"subscribe\"",
")",
"def",
"decorator",
"(",
"fn",
")... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.externalCall | Make a public API call without a connected :class:`.Skype` instance.
The obvious implications are that no authenticated calls are possible, though this allows accessing some public
APIs such as join URL lookups.
Args:
method (str): HTTP request method
url (str): full UR... | skpy/conn.py | def externalCall(cls, method, url, codes=(200, 201, 204, 207), **kwargs):
"""
Make a public API call without a connected :class:`.Skype` instance.
The obvious implications are that no authenticated calls are possible, though this allows accessing some public
APIs such as join URL lookup... | def externalCall(cls, method, url, codes=(200, 201, 204, 207), **kwargs):
"""
Make a public API call without a connected :class:`.Skype` instance.
The obvious implications are that no authenticated calls are possible, though this allows accessing some public
APIs such as join URL lookup... | [
"Make",
"a",
"public",
"API",
"call",
"without",
"a",
"connected",
":",
"class",
":",
".",
"Skype",
"instance",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L92-L125 | [
"def",
"externalCall",
"(",
"cls",
",",
"method",
",",
"url",
",",
"codes",
"=",
"(",
"200",
",",
"201",
",",
"204",
",",
"207",
")",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"os",
".",
"getenv",
"(",
"\"SKPY_DEBUG_HTTP\"",
")",
":",
"print",
"("... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.syncStateCall | Follow and track sync state URLs provided by an API endpoint, in order to implicitly handle pagination.
In the first call, ``url`` and ``params`` are used as-is. If a ``syncState`` endpoint is provided in the
response, subsequent calls go to the latest URL instead.
Args:
method (s... | skpy/conn.py | def syncStateCall(self, method, url, params={}, **kwargs):
"""
Follow and track sync state URLs provided by an API endpoint, in order to implicitly handle pagination.
In the first call, ``url`` and ``params`` are used as-is. If a ``syncState`` endpoint is provided in the
response, subs... | def syncStateCall(self, method, url, params={}, **kwargs):
"""
Follow and track sync state URLs provided by an API endpoint, in order to implicitly handle pagination.
In the first call, ``url`` and ``params`` are used as-is. If a ``syncState`` endpoint is provided in the
response, subs... | [
"Follow",
"and",
"track",
"sync",
"state",
"URLs",
"provided",
"by",
"an",
"API",
"endpoint",
"in",
"order",
"to",
"implicitly",
"handle",
"pagination",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L222-L254 | [
"def",
"syncStateCall",
"(",
"self",
",",
"method",
",",
"url",
",",
"params",
"=",
"{",
"}",
",",
"*",
"*",
"kwargs",
")",
":",
"try",
":",
"states",
"=",
"self",
".",
"syncStates",
"[",
"(",
"method",
",",
"url",
")",
"]",
"except",
"KeyError",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.setUserPwd | Replace the stub :meth:`getSkypeToken` method with one that connects via the Microsoft account flow using the
given credentials. Avoids storing the account password in an accessible way.
Args:
user (str): username or email address of the connecting account
pwd (str): password o... | skpy/conn.py | def setUserPwd(self, user, pwd):
"""
Replace the stub :meth:`getSkypeToken` method with one that connects via the Microsoft account flow using the
given credentials. Avoids storing the account password in an accessible way.
Args:
user (str): username or email address of the... | def setUserPwd(self, user, pwd):
"""
Replace the stub :meth:`getSkypeToken` method with one that connects via the Microsoft account flow using the
given credentials. Avoids storing the account password in an accessible way.
Args:
user (str): username or email address of the... | [
"Replace",
"the",
"stub",
":",
"meth",
":",
"getSkypeToken",
"method",
"with",
"one",
"that",
"connects",
"via",
"the",
"Microsoft",
"account",
"flow",
"using",
"the",
"given",
"credentials",
".",
"Avoids",
"storing",
"the",
"account",
"password",
"in",
"an",
... | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L256-L267 | [
"def",
"setUserPwd",
"(",
"self",
",",
"user",
",",
"pwd",
")",
":",
"def",
"getSkypeToken",
"(",
"self",
")",
":",
"self",
".",
"liveLogin",
"(",
"user",
",",
"pwd",
")",
"self",
".",
"getSkypeToken",
"=",
"MethodType",
"(",
"getSkypeToken",
",",
"sel... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.readToken | Attempt to re-establish a connection using previously acquired tokens.
If the Skype token is valid but the registration token is invalid, a new endpoint will be registered.
Raises:
.SkypeAuthException: if the token file cannot be used to authenticate | skpy/conn.py | def readToken(self):
"""
Attempt to re-establish a connection using previously acquired tokens.
If the Skype token is valid but the registration token is invalid, a new endpoint will be registered.
Raises:
.SkypeAuthException: if the token file cannot be used to authenticat... | def readToken(self):
"""
Attempt to re-establish a connection using previously acquired tokens.
If the Skype token is valid but the registration token is invalid, a new endpoint will be registered.
Raises:
.SkypeAuthException: if the token file cannot be used to authenticat... | [
"Attempt",
"to",
"re",
"-",
"establish",
"a",
"connection",
"using",
"previously",
"acquired",
"tokens",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L278-L310 | [
"def",
"readToken",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"tokenFile",
":",
"raise",
"SkypeAuthException",
"(",
"\"No token file specified\"",
")",
"try",
":",
"with",
"open",
"(",
"self",
".",
"tokenFile",
",",
"\"r\"",
")",
"as",
"f",
":",
"... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.writeToken | Store details of the current connection in the named file.
This can be used by :meth:`readToken` to re-authenticate at a later time. | skpy/conn.py | def writeToken(self):
"""
Store details of the current connection in the named file.
This can be used by :meth:`readToken` to re-authenticate at a later time.
"""
# Write token file privately.
with os.fdopen(os.open(self.tokenFile, os.O_WRONLY | os.O_CREAT, 0o600), "w") ... | def writeToken(self):
"""
Store details of the current connection in the named file.
This can be used by :meth:`readToken` to re-authenticate at a later time.
"""
# Write token file privately.
with os.fdopen(os.open(self.tokenFile, os.O_WRONLY | os.O_CREAT, 0o600), "w") ... | [
"Store",
"details",
"of",
"the",
"current",
"connection",
"in",
"the",
"named",
"file",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L312-L327 | [
"def",
"writeToken",
"(",
"self",
")",
":",
"# Write token file privately.",
"with",
"os",
".",
"fdopen",
"(",
"os",
".",
"open",
"(",
"self",
".",
"tokenFile",
",",
"os",
".",
"O_WRONLY",
"|",
"os",
".",
"O_CREAT",
",",
"0o600",
")",
",",
"\"w\"",
")"... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.verifyToken | Ensure the authentication token for the given auth method is still valid.
Args:
auth (Auth): authentication type to check
Raises:
.SkypeAuthException: if Skype auth is required, and the current token has expired and can't be renewed | skpy/conn.py | def verifyToken(self, auth):
"""
Ensure the authentication token for the given auth method is still valid.
Args:
auth (Auth): authentication type to check
Raises:
.SkypeAuthException: if Skype auth is required, and the current token has expired and can't be rene... | def verifyToken(self, auth):
"""
Ensure the authentication token for the given auth method is still valid.
Args:
auth (Auth): authentication type to check
Raises:
.SkypeAuthException: if Skype auth is required, and the current token has expired and can't be rene... | [
"Ensure",
"the",
"authentication",
"token",
"for",
"the",
"given",
"auth",
"method",
"is",
"still",
"valid",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L329-L346 | [
"def",
"verifyToken",
"(",
"self",
",",
"auth",
")",
":",
"if",
"auth",
"in",
"(",
"self",
".",
"Auth",
".",
"SkypeToken",
",",
"self",
".",
"Auth",
".",
"Authorize",
")",
":",
"if",
"\"skype\"",
"not",
"in",
"self",
".",
"tokenExpiry",
"or",
"dateti... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.liveLogin | Obtain connection parameters from the Microsoft account login page, and perform a login with the given email
address or Skype username, and its password. This emulates a login to Skype for Web on ``login.live.com``.
.. note::
Microsoft accounts with two-factor authentication enabled are no... | skpy/conn.py | def liveLogin(self, user, pwd):
"""
Obtain connection parameters from the Microsoft account login page, and perform a login with the given email
address or Skype username, and its password. This emulates a login to Skype for Web on ``login.live.com``.
.. note::
Microsoft ac... | def liveLogin(self, user, pwd):
"""
Obtain connection parameters from the Microsoft account login page, and perform a login with the given email
address or Skype username, and its password. This emulates a login to Skype for Web on ``login.live.com``.
.. note::
Microsoft ac... | [
"Obtain",
"connection",
"parameters",
"from",
"the",
"Microsoft",
"account",
"login",
"page",
"and",
"perform",
"a",
"login",
"with",
"the",
"given",
"email",
"address",
"or",
"Skype",
"username",
"and",
"its",
"password",
".",
"This",
"emulates",
"a",
"login"... | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L348-L370 | [
"def",
"liveLogin",
"(",
"self",
",",
"user",
",",
"pwd",
")",
":",
"self",
".",
"tokens",
"[",
"\"skype\"",
"]",
",",
"self",
".",
"tokenExpiry",
"[",
"\"skype\"",
"]",
"=",
"SkypeLiveAuthProvider",
"(",
"self",
")",
".",
"auth",
"(",
"user",
",",
"... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.guestLogin | Connect to Skype as a guest, joining a given conversation.
In this state, some APIs (such as contacts) will return 401 status codes. A guest can only communicate with
the conversation they originally joined.
Args:
url (str): public join URL for conversation, or identifier from it
... | skpy/conn.py | def guestLogin(self, url, name):
"""
Connect to Skype as a guest, joining a given conversation.
In this state, some APIs (such as contacts) will return 401 status codes. A guest can only communicate with
the conversation they originally joined.
Args:
url (str): pub... | def guestLogin(self, url, name):
"""
Connect to Skype as a guest, joining a given conversation.
In this state, some APIs (such as contacts) will return 401 status codes. A guest can only communicate with
the conversation they originally joined.
Args:
url (str): pub... | [
"Connect",
"to",
"Skype",
"as",
"a",
"guest",
"joining",
"a",
"given",
"conversation",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L372-L389 | [
"def",
"guestLogin",
"(",
"self",
",",
"url",
",",
"name",
")",
":",
"self",
".",
"tokens",
"[",
"\"skype\"",
"]",
",",
"self",
".",
"tokenExpiry",
"[",
"\"skype\"",
"]",
"=",
"SkypeGuestAuthProvider",
"(",
"self",
")",
".",
"auth",
"(",
"url",
",",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.refreshSkypeToken | Take the existing Skype token and refresh it, to extend the expiry time without other credentials.
Raises:
.SkypeAuthException: if the login request is rejected
.SkypeApiException: if the login form can't be processed | skpy/conn.py | def refreshSkypeToken(self):
"""
Take the existing Skype token and refresh it, to extend the expiry time without other credentials.
Raises:
.SkypeAuthException: if the login request is rejected
.SkypeApiException: if the login form can't be processed
"""
... | def refreshSkypeToken(self):
"""
Take the existing Skype token and refresh it, to extend the expiry time without other credentials.
Raises:
.SkypeAuthException: if the login request is rejected
.SkypeApiException: if the login form can't be processed
"""
... | [
"Take",
"the",
"existing",
"Skype",
"token",
"and",
"refresh",
"it",
"to",
"extend",
"the",
"expiry",
"time",
"without",
"other",
"credentials",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L400-L409 | [
"def",
"refreshSkypeToken",
"(",
"self",
")",
":",
"self",
".",
"tokens",
"[",
"\"skype\"",
"]",
",",
"self",
".",
"tokenExpiry",
"[",
"\"skype\"",
"]",
"=",
"SkypeRefreshAuthProvider",
"(",
"self",
")",
".",
"auth",
"(",
"self",
".",
"tokens",
"[",
"\"s... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.getUserId | Ask Skype for the authenticated user's identifier, and store it on the connection object. | skpy/conn.py | def getUserId(self):
"""
Ask Skype for the authenticated user's identifier, and store it on the connection object.
"""
self.userId = self("GET", "{0}/users/self/profile".format(self.API_USER),
auth=self.Auth.SkypeToken).json().get("username") | def getUserId(self):
"""
Ask Skype for the authenticated user's identifier, and store it on the connection object.
"""
self.userId = self("GET", "{0}/users/self/profile".format(self.API_USER),
auth=self.Auth.SkypeToken).json().get("username") | [
"Ask",
"Skype",
"for",
"the",
"authenticated",
"user",
"s",
"identifier",
"and",
"store",
"it",
"on",
"the",
"connection",
"object",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L411-L416 | [
"def",
"getUserId",
"(",
"self",
")",
":",
"self",
".",
"userId",
"=",
"self",
"(",
"\"GET\"",
",",
"\"{0}/users/self/profile\"",
".",
"format",
"(",
"self",
".",
"API_USER",
")",
",",
"auth",
"=",
"self",
".",
"Auth",
".",
"SkypeToken",
")",
".",
"jso... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.getRegToken | Acquire a new registration token.
Once successful, all tokens and expiry times are written to the token file (if specified on initialisation). | skpy/conn.py | def getRegToken(self):
"""
Acquire a new registration token.
Once successful, all tokens and expiry times are written to the token file (if specified on initialisation).
"""
self.verifyToken(self.Auth.SkypeToken)
token, expiry, msgsHost, endpoint = SkypeRegistrationToken... | def getRegToken(self):
"""
Acquire a new registration token.
Once successful, all tokens and expiry times are written to the token file (if specified on initialisation).
"""
self.verifyToken(self.Auth.SkypeToken)
token, expiry, msgsHost, endpoint = SkypeRegistrationToken... | [
"Acquire",
"a",
"new",
"registration",
"token",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L418-L434 | [
"def",
"getRegToken",
"(",
"self",
")",
":",
"self",
".",
"verifyToken",
"(",
"self",
".",
"Auth",
".",
"SkypeToken",
")",
"token",
",",
"expiry",
",",
"msgsHost",
",",
"endpoint",
"=",
"SkypeRegistrationTokenProvider",
"(",
"self",
")",
".",
"auth",
"(",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeConnection.syncEndpoints | Retrieve all current endpoints for the connected user. | skpy/conn.py | def syncEndpoints(self):
"""
Retrieve all current endpoints for the connected user.
"""
self.endpoints["all"] = []
for json in self("GET", "{0}/users/ME/presenceDocs/messagingService".format(self.msgsHost),
params={"view": "expanded"}, auth=self.Auth.RegT... | def syncEndpoints(self):
"""
Retrieve all current endpoints for the connected user.
"""
self.endpoints["all"] = []
for json in self("GET", "{0}/users/ME/presenceDocs/messagingService".format(self.msgsHost),
params={"view": "expanded"}, auth=self.Auth.RegT... | [
"Retrieve",
"all",
"current",
"endpoints",
"for",
"the",
"connected",
"user",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L436-L444 | [
"def",
"syncEndpoints",
"(",
"self",
")",
":",
"self",
".",
"endpoints",
"[",
"\"all\"",
"]",
"=",
"[",
"]",
"for",
"json",
"in",
"self",
"(",
"\"GET\"",
",",
"\"{0}/users/ME/presenceDocs/messagingService\"",
".",
"format",
"(",
"self",
".",
"msgsHost",
")",... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeAPIAuthProvider.auth | Perform a login with the given Skype username and its password. This emulates a login to Skype for Web on
``api.skype.com``.
Args:
user (str): username of the connecting account
pwd (str): password of the connecting account
Returns:
(str, datetime.datetime)... | skpy/conn.py | def auth(self, user, pwd):
"""
Perform a login with the given Skype username and its password. This emulates a login to Skype for Web on
``api.skype.com``.
Args:
user (str): username of the connecting account
pwd (str): password of the connecting account
... | def auth(self, user, pwd):
"""
Perform a login with the given Skype username and its password. This emulates a login to Skype for Web on
``api.skype.com``.
Args:
user (str): username of the connecting account
pwd (str): password of the connecting account
... | [
"Perform",
"a",
"login",
"with",
"the",
"given",
"Skype",
"username",
"and",
"its",
"password",
".",
"This",
"emulates",
"a",
"login",
"to",
"Skype",
"for",
"Web",
"on",
"api",
".",
"skype",
".",
"com",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L474-L499 | [
"def",
"auth",
"(",
"self",
",",
"user",
",",
"pwd",
")",
":",
"# Wrap up the credentials ready to send.",
"pwdHash",
"=",
"base64",
".",
"b64encode",
"(",
"hashlib",
".",
"md5",
"(",
"(",
"user",
"+",
"\"\\nskyper\\n\"",
"+",
"pwd",
")",
".",
"encode",
"(... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeLiveAuthProvider.checkUser | Query a username or email address to see if a corresponding Microsoft account exists.
Args:
user (str): username or email address of an account
Returns:
bool: whether the account exists | skpy/conn.py | def checkUser(self, user):
"""
Query a username or email address to see if a corresponding Microsoft account exists.
Args:
user (str): username or email address of an account
Returns:
bool: whether the account exists
"""
return not self.conn("POS... | def checkUser(self, user):
"""
Query a username or email address to see if a corresponding Microsoft account exists.
Args:
user (str): username or email address of an account
Returns:
bool: whether the account exists
"""
return not self.conn("POS... | [
"Query",
"a",
"username",
"or",
"email",
"address",
"to",
"see",
"if",
"a",
"corresponding",
"Microsoft",
"account",
"exists",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L507-L518 | [
"def",
"checkUser",
"(",
"self",
",",
"user",
")",
":",
"return",
"not",
"self",
".",
"conn",
"(",
"\"POST\"",
",",
"\"{0}/GetCredentialType.srf\"",
".",
"format",
"(",
"SkypeConnection",
".",
"API_MSACC",
")",
",",
"json",
"=",
"{",
"\"username\"",
":",
"... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeLiveAuthProvider.auth | Obtain connection parameters from the Microsoft account login page, and perform a login with the given email
address or Skype username, and its password. This emulates a login to Skype for Web on ``login.live.com``.
.. note::
Microsoft accounts with two-factor authentication enabled are no... | skpy/conn.py | def auth(self, user, pwd):
"""
Obtain connection parameters from the Microsoft account login page, and perform a login with the given email
address or Skype username, and its password. This emulates a login to Skype for Web on ``login.live.com``.
.. note::
Microsoft account... | def auth(self, user, pwd):
"""
Obtain connection parameters from the Microsoft account login page, and perform a login with the given email
address or Skype username, and its password. This emulates a login to Skype for Web on ``login.live.com``.
.. note::
Microsoft account... | [
"Obtain",
"connection",
"parameters",
"from",
"the",
"Microsoft",
"account",
"login",
"page",
"and",
"perform",
"a",
"login",
"with",
"the",
"given",
"email",
"address",
"or",
"Skype",
"username",
"and",
"its",
"password",
".",
"This",
"emulates",
"a",
"login"... | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L520-L543 | [
"def",
"auth",
"(",
"self",
",",
"user",
",",
"pwd",
")",
":",
"# Do the authentication dance.",
"params",
"=",
"self",
".",
"getParams",
"(",
")",
"t",
"=",
"self",
".",
"sendCreds",
"(",
"user",
",",
"pwd",
",",
"params",
")",
"return",
"self",
".",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeGuestAuthProvider.auth | Connect to Skype as a guest, joining a given conversation.
In this state, some APIs (such as contacts) will return 401 status codes. A guest can only communicate with
the conversation they originally joined.
Args:
url (str): public join URL for conversation, or identifier from it
... | skpy/conn.py | def auth(self, url, name):
"""
Connect to Skype as a guest, joining a given conversation.
In this state, some APIs (such as contacts) will return 401 status codes. A guest can only communicate with
the conversation they originally joined.
Args:
url (str): public jo... | def auth(self, url, name):
"""
Connect to Skype as a guest, joining a given conversation.
In this state, some APIs (such as contacts) will return 401 status codes. A guest can only communicate with
the conversation they originally joined.
Args:
url (str): public jo... | [
"Connect",
"to",
"Skype",
"as",
"a",
"guest",
"joining",
"a",
"given",
"conversation",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L602-L638 | [
"def",
"auth",
"(",
"self",
",",
"url",
",",
"name",
")",
":",
"urlId",
"=",
"url",
".",
"split",
"(",
"\"/\"",
")",
"[",
"-",
"1",
"]",
"# Pretend to be Chrome on Windows (required to avoid \"unsupported device\" messages).",
"agent",
"=",
"\"Mozilla/5.0 (Windows N... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeRefreshAuthProvider.auth | Take an existing Skype token and refresh it, to extend the expiry time without other credentials.
Args:
token (str): existing Skype token
Returns:
(str, datetime.datetime) tuple: Skype token, and associated expiry if known
Raises:
.SkypeAuthException: if th... | skpy/conn.py | def auth(self, token):
"""
Take an existing Skype token and refresh it, to extend the expiry time without other credentials.
Args:
token (str): existing Skype token
Returns:
(str, datetime.datetime) tuple: Skype token, and associated expiry if known
Rai... | def auth(self, token):
"""
Take an existing Skype token and refresh it, to extend the expiry time without other credentials.
Args:
token (str): existing Skype token
Returns:
(str, datetime.datetime) tuple: Skype token, and associated expiry if known
Rai... | [
"Take",
"an",
"existing",
"Skype",
"token",
"and",
"refresh",
"it",
"to",
"extend",
"the",
"expiry",
"time",
"without",
"other",
"credentials",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L646-L661 | [
"def",
"auth",
"(",
"self",
",",
"token",
")",
":",
"t",
"=",
"self",
".",
"sendToken",
"(",
"token",
")",
"return",
"self",
".",
"getToken",
"(",
"t",
")"
] | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeRegistrationTokenProvider.auth | Request a new registration token using a current Skype token.
Args:
skypeToken (str): existing Skype token
Returns:
(str, datetime.datetime, str, SkypeEndpoint) tuple: registration token, associated expiry if known,
... | skpy/conn.py | def auth(self, skypeToken):
"""
Request a new registration token using a current Skype token.
Args:
skypeToken (str): existing Skype token
Returns:
(str, datetime.datetime, str, SkypeEndpoint) tuple: registration token, associated expiry if known,
... | def auth(self, skypeToken):
"""
Request a new registration token using a current Skype token.
Args:
skypeToken (str): existing Skype token
Returns:
(str, datetime.datetime, str, SkypeEndpoint) tuple: registration token, associated expiry if known,
... | [
"Request",
"a",
"new",
"registration",
"token",
"using",
"a",
"current",
"Skype",
"token",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L701-L746 | [
"def",
"auth",
"(",
"self",
",",
"skypeToken",
")",
":",
"token",
"=",
"expiry",
"=",
"endpoint",
"=",
"None",
"msgsHost",
"=",
"SkypeConnection",
".",
"API_MSGSHOST",
"while",
"not",
"token",
":",
"secs",
"=",
"int",
"(",
"time",
".",
"time",
"(",
")"... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeRegistrationTokenProvider.getMac256Hash | Generate the lock-and-key response, needed to acquire registration tokens. | skpy/conn.py | def getMac256Hash(challenge, appId="msmsgs@msnmsgr.com", key="Q1P7W2E4J9R8U3S5"):
"""
Generate the lock-and-key response, needed to acquire registration tokens.
"""
clearText = challenge + appId
clearText += "0" * (8 - len(clearText) % 8)
def int32ToHexString(n):
... | def getMac256Hash(challenge, appId="msmsgs@msnmsgr.com", key="Q1P7W2E4J9R8U3S5"):
"""
Generate the lock-and-key response, needed to acquire registration tokens.
"""
clearText = challenge + appId
clearText += "0" * (8 - len(clearText) % 8)
def int32ToHexString(n):
... | [
"Generate",
"the",
"lock",
"-",
"and",
"-",
"key",
"response",
"needed",
"to",
"acquire",
"registration",
"tokens",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L749-L830 | [
"def",
"getMac256Hash",
"(",
"challenge",
",",
"appId",
"=",
"\"msmsgs@msnmsgr.com\"",
",",
"key",
"=",
"\"Q1P7W2E4J9R8U3S5\"",
")",
":",
"clearText",
"=",
"challenge",
"+",
"appId",
"clearText",
"+=",
"\"0\"",
"*",
"(",
"8",
"-",
"len",
"(",
"clearText",
")... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeEndpoint.config | Configure this endpoint to allow setting presence.
Args:
name (str): display name for this endpoint | skpy/conn.py | def config(self, name="skype"):
"""
Configure this endpoint to allow setting presence.
Args:
name (str): display name for this endpoint
"""
self.conn("PUT", "{0}/users/ME/endpoints/{1}/presenceDocs/messagingService"
.format(self.conn.msgsHost... | def config(self, name="skype"):
"""
Configure this endpoint to allow setting presence.
Args:
name (str): display name for this endpoint
"""
self.conn("PUT", "{0}/users/ME/endpoints/{1}/presenceDocs/messagingService"
.format(self.conn.msgsHost... | [
"Configure",
"this",
"endpoint",
"to",
"allow",
"setting",
"presence",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L857-L875 | [
"def",
"config",
"(",
"self",
",",
"name",
"=",
"\"skype\"",
")",
":",
"self",
".",
"conn",
"(",
"\"PUT\"",
",",
"\"{0}/users/ME/endpoints/{1}/presenceDocs/messagingService\"",
".",
"format",
"(",
"self",
".",
"conn",
".",
"msgsHost",
",",
"self",
".",
"id",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeEndpoint.ping | Send a keep-alive request for the endpoint.
Args:
timeout (int): maximum amount of time for the endpoint to stay active | skpy/conn.py | def ping(self, timeout=12):
"""
Send a keep-alive request for the endpoint.
Args:
timeout (int): maximum amount of time for the endpoint to stay active
"""
self.conn("POST", "{0}/users/ME/endpoints/{1}/active".format(self.conn.msgsHost, self.id),
au... | def ping(self, timeout=12):
"""
Send a keep-alive request for the endpoint.
Args:
timeout (int): maximum amount of time for the endpoint to stay active
"""
self.conn("POST", "{0}/users/ME/endpoints/{1}/active".format(self.conn.msgsHost, self.id),
au... | [
"Send",
"a",
"keep",
"-",
"alive",
"request",
"for",
"the",
"endpoint",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L877-L885 | [
"def",
"ping",
"(",
"self",
",",
"timeout",
"=",
"12",
")",
":",
"self",
".",
"conn",
"(",
"\"POST\"",
",",
"\"{0}/users/ME/endpoints/{1}/active\"",
".",
"format",
"(",
"self",
".",
"conn",
".",
"msgsHost",
",",
"self",
".",
"id",
")",
",",
"auth",
"="... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeEndpoint.subscribe | Subscribe to contact and conversation events. These are accessible through :meth:`getEvents`. | skpy/conn.py | def subscribe(self):
"""
Subscribe to contact and conversation events. These are accessible through :meth:`getEvents`.
"""
self.conn("POST", "{0}/users/ME/endpoints/{1}/subscriptions".format(self.conn.msgsHost, self.id),
auth=SkypeConnection.Auth.RegToken,
... | def subscribe(self):
"""
Subscribe to contact and conversation events. These are accessible through :meth:`getEvents`.
"""
self.conn("POST", "{0}/users/ME/endpoints/{1}/subscriptions".format(self.conn.msgsHost, self.id),
auth=SkypeConnection.Auth.RegToken,
... | [
"Subscribe",
"to",
"contact",
"and",
"conversation",
"events",
".",
"These",
"are",
"accessible",
"through",
":",
"meth",
":",
"getEvents",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/conn.py#L887-L899 | [
"def",
"subscribe",
"(",
"self",
")",
":",
"self",
".",
"conn",
"(",
"\"POST\"",
",",
"\"{0}/users/ME/endpoints/{1}/subscriptions\"",
".",
"format",
"(",
"self",
".",
"conn",
".",
"msgsHost",
",",
"self",
".",
"id",
")",
",",
"auth",
"=",
"SkypeConnection",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeChats.recent | Retrieve a selection of conversations with the most recent activity, and store them in the cache.
Each conversation is only retrieved once, so subsequent calls will retrieve older conversations.
Returns:
:class:`SkypeChat` list: collection of recent conversations | skpy/chat.py | def recent(self):
"""
Retrieve a selection of conversations with the most recent activity, and store them in the cache.
Each conversation is only retrieved once, so subsequent calls will retrieve older conversations.
Returns:
:class:`SkypeChat` list: collection of recent co... | def recent(self):
"""
Retrieve a selection of conversations with the most recent activity, and store them in the cache.
Each conversation is only retrieved once, so subsequent calls will retrieve older conversations.
Returns:
:class:`SkypeChat` list: collection of recent co... | [
"Retrieve",
"a",
"selection",
"of",
"conversations",
"with",
"the",
"most",
"recent",
"activity",
"and",
"store",
"them",
"in",
"the",
"cache",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/chat.py#L397-L421 | [
"def",
"recent",
"(",
"self",
")",
":",
"url",
"=",
"\"{0}/users/ME/conversations\"",
".",
"format",
"(",
"self",
".",
"skype",
".",
"conn",
".",
"msgsHost",
")",
"params",
"=",
"{",
"\"startTime\"",
":",
"0",
",",
"\"view\"",
":",
"\"msnp24Equivalent\"",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeChats.chat | Get a single conversation by identifier.
Args:
id (str): single or group chat identifier | skpy/chat.py | def chat(self, id):
"""
Get a single conversation by identifier.
Args:
id (str): single or group chat identifier
"""
json = self.skype.conn("GET", "{0}/users/ME/conversations/{1}".format(self.skype.conn.msgsHost, id),
auth=SkypeConnecti... | def chat(self, id):
"""
Get a single conversation by identifier.
Args:
id (str): single or group chat identifier
"""
json = self.skype.conn("GET", "{0}/users/ME/conversations/{1}".format(self.skype.conn.msgsHost, id),
auth=SkypeConnecti... | [
"Get",
"a",
"single",
"conversation",
"by",
"identifier",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/chat.py#L423-L438 | [
"def",
"chat",
"(",
"self",
",",
"id",
")",
":",
"json",
"=",
"self",
".",
"skype",
".",
"conn",
"(",
"\"GET\"",
",",
"\"{0}/users/ME/conversations/{1}\"",
".",
"format",
"(",
"self",
".",
"skype",
".",
"conn",
".",
"msgsHost",
",",
"id",
")",
",",
"... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeChats.create | Create a new group chat with the given users.
The current user is automatically added to the conversation as an admin. Any other admin identifiers must also
be present in the member list.
Args:
members (str list): user identifiers to initially join the conversation
adm... | skpy/chat.py | def create(self, members=(), admins=()):
"""
Create a new group chat with the given users.
The current user is automatically added to the conversation as an admin. Any other admin identifiers must also
be present in the member list.
Args:
members (str list): user i... | def create(self, members=(), admins=()):
"""
Create a new group chat with the given users.
The current user is automatically added to the conversation as an admin. Any other admin identifiers must also
be present in the member list.
Args:
members (str list): user i... | [
"Create",
"a",
"new",
"group",
"chat",
"with",
"the",
"given",
"users",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/chat.py#L440-L458 | [
"def",
"create",
"(",
"self",
",",
"members",
"=",
"(",
")",
",",
"admins",
"=",
"(",
")",
")",
":",
"memberObjs",
"=",
"[",
"{",
"\"id\"",
":",
"\"8:{0}\"",
".",
"format",
"(",
"self",
".",
"skype",
".",
"userId",
")",
",",
"\"role\"",
":",
"\"A... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeChats.urlToIds | Resolve a ``join.skype.com`` URL and returns various identifiers for the group conversation.
Args:
url (str): public join URL, or identifier from it
Returns:
dict: related conversation's identifiers -- keys: ``id``, ``long``, ``blob`` | skpy/chat.py | def urlToIds(url):
"""
Resolve a ``join.skype.com`` URL and returns various identifiers for the group conversation.
Args:
url (str): public join URL, or identifier from it
Returns:
dict: related conversation's identifiers -- keys: ``id``, ``long``, ``blob``
... | def urlToIds(url):
"""
Resolve a ``join.skype.com`` URL and returns various identifiers for the group conversation.
Args:
url (str): public join URL, or identifier from it
Returns:
dict: related conversation's identifiers -- keys: ``id``, ``long``, ``blob``
... | [
"Resolve",
"a",
"join",
".",
"skype",
".",
"com",
"URL",
"and",
"returns",
"various",
"identifiers",
"for",
"the",
"group",
"conversation",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/chat.py#L462-L477 | [
"def",
"urlToIds",
"(",
"url",
")",
":",
"urlId",
"=",
"url",
".",
"split",
"(",
"\"/\"",
")",
"[",
"-",
"1",
"]",
"convUrl",
"=",
"\"https://join.skype.com/api/v2/conversation/\"",
"json",
"=",
"SkypeConnection",
".",
"externalCall",
"(",
"\"POST\"",
",",
"... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeUtils.userToId | Extract the username from a contact URL.
Matches addresses containing ``users/<user>`` or ``users/ME/contacts/<user>``.
Args:
url (str): Skype API URL
Returns:
str: extracted identifier | skpy/util.py | def userToId(url):
"""
Extract the username from a contact URL.
Matches addresses containing ``users/<user>`` or ``users/ME/contacts/<user>``.
Args:
url (str): Skype API URL
Returns:
str: extracted identifier
"""
match = re.search(r"user... | def userToId(url):
"""
Extract the username from a contact URL.
Matches addresses containing ``users/<user>`` or ``users/ME/contacts/<user>``.
Args:
url (str): Skype API URL
Returns:
str: extracted identifier
"""
match = re.search(r"user... | [
"Extract",
"the",
"username",
"from",
"a",
"contact",
"URL",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/util.py#L54-L67 | [
"def",
"userToId",
"(",
"url",
")",
":",
"match",
"=",
"re",
".",
"search",
"(",
"r\"users(/ME/contacts)?/[0-9]+:([^/]+)\"",
",",
"url",
")",
"return",
"match",
".",
"group",
"(",
"2",
")",
"if",
"match",
"else",
"None"
] | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeUtils.chatToId | Extract the conversation ID from a conversation URL.
Matches addresses containing ``conversations/<chat>``.
Args:
url (str): Skype API URL
Returns:
str: extracted identifier | skpy/util.py | def chatToId(url):
"""
Extract the conversation ID from a conversation URL.
Matches addresses containing ``conversations/<chat>``.
Args:
url (str): Skype API URL
Returns:
str: extracted identifier
"""
match = re.search(r"conversations/([... | def chatToId(url):
"""
Extract the conversation ID from a conversation URL.
Matches addresses containing ``conversations/<chat>``.
Args:
url (str): Skype API URL
Returns:
str: extracted identifier
"""
match = re.search(r"conversations/([... | [
"Extract",
"the",
"conversation",
"ID",
"from",
"a",
"conversation",
"URL",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/util.py#L70-L83 | [
"def",
"chatToId",
"(",
"url",
")",
":",
"match",
"=",
"re",
".",
"search",
"(",
"r\"conversations/([0-9]+:[^/]+)\"",
",",
"url",
")",
"return",
"match",
".",
"group",
"(",
"1",
")",
"if",
"match",
"else",
"None"
] | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeUtils.initAttrs | Class decorator: automatically generate an ``__init__`` method that expects args from cls.attrs and stores them.
Args:
cls (class): class to decorate
Returns:
class: same, but modified, class | skpy/util.py | def initAttrs(cls):
"""
Class decorator: automatically generate an ``__init__`` method that expects args from cls.attrs and stores them.
Args:
cls (class): class to decorate
Returns:
class: same, but modified, class
"""
def __init__(self, skype=N... | def initAttrs(cls):
"""
Class decorator: automatically generate an ``__init__`` method that expects args from cls.attrs and stores them.
Args:
cls (class): class to decorate
Returns:
class: same, but modified, class
"""
def __init__(self, skype=N... | [
"Class",
"decorator",
":",
"automatically",
"generate",
"an",
"__init__",
"method",
"that",
"expects",
"args",
"from",
"cls",
".",
"attrs",
"and",
"stores",
"them",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/util.py#L94-L121 | [
"def",
"initAttrs",
"(",
"cls",
")",
":",
"def",
"__init__",
"(",
"self",
",",
"skype",
"=",
"None",
",",
"raw",
"=",
"None",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"super",
"(",
"cls",
",",
"self",
")",
".",
"__init__",
"(",
"sky... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeUtils.convertIds | Class decorator: add helper methods to convert identifier properties into SkypeObjs.
Args:
types (str list): simple field types to add properties for (``user``, ``users`` or ``chat``)
user (str list): attribute names to treat as single user identifier fields
users (str list)... | skpy/util.py | def convertIds(*types, **kwargs):
"""
Class decorator: add helper methods to convert identifier properties into SkypeObjs.
Args:
types (str list): simple field types to add properties for (``user``, ``users`` or ``chat``)
user (str list): attribute names to treat as sing... | def convertIds(*types, **kwargs):
"""
Class decorator: add helper methods to convert identifier properties into SkypeObjs.
Args:
types (str list): simple field types to add properties for (``user``, ``users`` or ``chat``)
user (str list): attribute names to treat as sing... | [
"Class",
"decorator",
":",
"add",
"helper",
"methods",
"to",
"convert",
"identifier",
"properties",
"into",
"SkypeObjs",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/util.py#L124-L180 | [
"def",
"convertIds",
"(",
"*",
"types",
",",
"*",
"*",
"kwargs",
")",
":",
"user",
"=",
"kwargs",
".",
"get",
"(",
"\"user\"",
",",
"(",
")",
")",
"users",
"=",
"kwargs",
".",
"get",
"(",
"\"users\"",
",",
"(",
")",
")",
"chat",
"=",
"kwargs",
... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeUtils.truthyAttrs | Class decorator: override __bool__ to set truthiness based on any attr being present.
Args:
cls (class): class to decorate
Returns:
class: same, but modified, class | skpy/util.py | def truthyAttrs(cls):
"""
Class decorator: override __bool__ to set truthiness based on any attr being present.
Args:
cls (class): class to decorate
Returns:
class: same, but modified, class
"""
def __bool__(self):
return bool(any(get... | def truthyAttrs(cls):
"""
Class decorator: override __bool__ to set truthiness based on any attr being present.
Args:
cls (class): class to decorate
Returns:
class: same, but modified, class
"""
def __bool__(self):
return bool(any(get... | [
"Class",
"decorator",
":",
"override",
"__bool__",
"to",
"set",
"truthiness",
"based",
"on",
"any",
"attr",
"being",
"present",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/util.py#L183-L197 | [
"def",
"truthyAttrs",
"(",
"cls",
")",
":",
"def",
"__bool__",
"(",
"self",
")",
":",
"return",
"bool",
"(",
"any",
"(",
"getattr",
"(",
"self",
",",
"attr",
")",
"for",
"attr",
"in",
"self",
".",
"attrs",
")",
")",
"cls",
".",
"__bool__",
"=",
"... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeUtils.cacheResult | Method decorator: calculate the value on first access, produce the cached value thereafter.
If the function takes arguments, the cache is a dictionary using all arguments as the key.
Args:
fn (method): function to decorate
Returns:
method: wrapper function with caching | skpy/util.py | def cacheResult(fn):
"""
Method decorator: calculate the value on first access, produce the cached value thereafter.
If the function takes arguments, the cache is a dictionary using all arguments as the key.
Args:
fn (method): function to decorate
Returns:
... | def cacheResult(fn):
"""
Method decorator: calculate the value on first access, produce the cached value thereafter.
If the function takes arguments, the cache is a dictionary using all arguments as the key.
Args:
fn (method): function to decorate
Returns:
... | [
"Method",
"decorator",
":",
"calculate",
"the",
"value",
"on",
"first",
"access",
"produce",
"the",
"cached",
"value",
"thereafter",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/util.py#L200-L232 | [
"def",
"cacheResult",
"(",
"fn",
")",
":",
"cache",
"=",
"{",
"}",
"@",
"functools",
".",
"wraps",
"(",
"fn",
")",
"def",
"wrapper",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"# Imperfect key generation (args may be passed as kwargs, so multiple way... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | SkypeUtils.exhaust | Repeatedly call a function, starting with init, until false-y, yielding each item in turn.
The ``transform`` parameter can be used to map a collection to another format, for example iterating over a
:class:`dict` by value rather than key.
Use with state-synced functions to retrieve all results... | skpy/util.py | def exhaust(fn, transform=None, *args, **kwargs):
"""
Repeatedly call a function, starting with init, until false-y, yielding each item in turn.
The ``transform`` parameter can be used to map a collection to another format, for example iterating over a
:class:`dict` by value rather than... | def exhaust(fn, transform=None, *args, **kwargs):
"""
Repeatedly call a function, starting with init, until false-y, yielding each item in turn.
The ``transform`` parameter can be used to map a collection to another format, for example iterating over a
:class:`dict` by value rather than... | [
"Repeatedly",
"call",
"a",
"function",
"starting",
"with",
"init",
"until",
"false",
"-",
"y",
"yielding",
"each",
"item",
"in",
"turn",
"."
] | Terrance/SkPy | python | https://github.com/Terrance/SkPy/blob/0f9489c94e8ec4d3effab4314497428872a80ad1/skpy/util.py#L235-L259 | [
"def",
"exhaust",
"(",
"fn",
",",
"transform",
"=",
"None",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"while",
"True",
":",
"iterRes",
"=",
"fn",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"if",
"iterRes",
":",
"for",
"item",
"i... | 0f9489c94e8ec4d3effab4314497428872a80ad1 |
test | u | Return unicode text, no matter what | frontmatter/util.py | def u(text, encoding='utf-8'):
"Return unicode text, no matter what"
if isinstance(text, six.binary_type):
text = text.decode(encoding)
# it's already unicode
text = text.replace('\r\n', '\n')
return text | def u(text, encoding='utf-8'):
"Return unicode text, no matter what"
if isinstance(text, six.binary_type):
text = text.decode(encoding)
# it's already unicode
text = text.replace('\r\n', '\n')
return text | [
"Return",
"unicode",
"text",
"no",
"matter",
"what"
] | eyeseast/python-frontmatter | python | https://github.com/eyeseast/python-frontmatter/blob/c318e583c48599eb597e0ad59c5d972258c3febc/frontmatter/util.py#L7-L15 | [
"def",
"u",
"(",
"text",
",",
"encoding",
"=",
"'utf-8'",
")",
":",
"if",
"isinstance",
"(",
"text",
",",
"six",
".",
"binary_type",
")",
":",
"text",
"=",
"text",
".",
"decode",
"(",
"encoding",
")",
"# it's already unicode",
"text",
"=",
"text",
".",... | c318e583c48599eb597e0ad59c5d972258c3febc |
test | detect_format | Figure out which handler to use, based on metadata.
Returns a handler instance or None.
``text`` should be unicode text about to be parsed.
``handlers`` is a dictionary where keys are opening delimiters
and values are handler instances. | frontmatter/__init__.py | def detect_format(text, handlers):
"""
Figure out which handler to use, based on metadata.
Returns a handler instance or None.
``text`` should be unicode text about to be parsed.
``handlers`` is a dictionary where keys are opening delimiters
and values are handler instances.
"""
for p... | def detect_format(text, handlers):
"""
Figure out which handler to use, based on metadata.
Returns a handler instance or None.
``text`` should be unicode text about to be parsed.
``handlers`` is a dictionary where keys are opening delimiters
and values are handler instances.
"""
for p... | [
"Figure",
"out",
"which",
"handler",
"to",
"use",
"based",
"on",
"metadata",
".",
"Returns",
"a",
"handler",
"instance",
"or",
"None",
"."
] | eyeseast/python-frontmatter | python | https://github.com/eyeseast/python-frontmatter/blob/c318e583c48599eb597e0ad59c5d972258c3febc/frontmatter/__init__.py#L34-L49 | [
"def",
"detect_format",
"(",
"text",
",",
"handlers",
")",
":",
"for",
"pattern",
",",
"handler",
"in",
"handlers",
".",
"items",
"(",
")",
":",
"if",
"pattern",
".",
"match",
"(",
"text",
")",
":",
"return",
"handler",
"# nothing matched, give nothing back"... | c318e583c48599eb597e0ad59c5d972258c3febc |
test | parse | Parse text with frontmatter, return metadata and content.
Pass in optional metadata defaults as keyword args.
If frontmatter is not found, returns an empty metadata dictionary
(or defaults) and original text content.
::
>>> with open('tests/hello-world.markdown') as f:
... metadat... | frontmatter/__init__.py | def parse(text, encoding='utf-8', handler=None, **defaults):
"""
Parse text with frontmatter, return metadata and content.
Pass in optional metadata defaults as keyword args.
If frontmatter is not found, returns an empty metadata dictionary
(or defaults) and original text content.
::
... | def parse(text, encoding='utf-8', handler=None, **defaults):
"""
Parse text with frontmatter, return metadata and content.
Pass in optional metadata defaults as keyword args.
If frontmatter is not found, returns an empty metadata dictionary
(or defaults) and original text content.
::
... | [
"Parse",
"text",
"with",
"frontmatter",
"return",
"metadata",
"and",
"content",
".",
"Pass",
"in",
"optional",
"metadata",
"defaults",
"as",
"keyword",
"args",
"."
] | eyeseast/python-frontmatter | python | https://github.com/eyeseast/python-frontmatter/blob/c318e583c48599eb597e0ad59c5d972258c3febc/frontmatter/__init__.py#L52-L91 | [
"def",
"parse",
"(",
"text",
",",
"encoding",
"=",
"'utf-8'",
",",
"handler",
"=",
"None",
",",
"*",
"*",
"defaults",
")",
":",
"# ensure unicode first",
"text",
"=",
"u",
"(",
"text",
",",
"encoding",
")",
".",
"strip",
"(",
")",
"# metadata starts with... | c318e583c48599eb597e0ad59c5d972258c3febc |
test | load | Load and parse a file-like object or filename,
return a :py:class:`post <frontmatter.Post>`.
::
>>> post = frontmatter.load('tests/hello-world.markdown')
>>> with open('tests/hello-world.markdown') as f:
... post = frontmatter.load(f) | frontmatter/__init__.py | def load(fd, encoding='utf-8', handler=None, **defaults):
"""
Load and parse a file-like object or filename,
return a :py:class:`post <frontmatter.Post>`.
::
>>> post = frontmatter.load('tests/hello-world.markdown')
>>> with open('tests/hello-world.markdown') as f:
... pos... | def load(fd, encoding='utf-8', handler=None, **defaults):
"""
Load and parse a file-like object or filename,
return a :py:class:`post <frontmatter.Post>`.
::
>>> post = frontmatter.load('tests/hello-world.markdown')
>>> with open('tests/hello-world.markdown') as f:
... pos... | [
"Load",
"and",
"parse",
"a",
"file",
"-",
"like",
"object",
"or",
"filename",
"return",
"a",
":",
"py",
":",
"class",
":",
"post",
"<frontmatter",
".",
"Post",
">",
"."
] | eyeseast/python-frontmatter | python | https://github.com/eyeseast/python-frontmatter/blob/c318e583c48599eb597e0ad59c5d972258c3febc/frontmatter/__init__.py#L94-L114 | [
"def",
"load",
"(",
"fd",
",",
"encoding",
"=",
"'utf-8'",
",",
"handler",
"=",
"None",
",",
"*",
"*",
"defaults",
")",
":",
"if",
"hasattr",
"(",
"fd",
",",
"'read'",
")",
":",
"text",
"=",
"fd",
".",
"read",
"(",
")",
"else",
":",
"with",
"co... | c318e583c48599eb597e0ad59c5d972258c3febc |
test | loads | Parse text (binary or unicode) and return a :py:class:`post <frontmatter.Post>`.
::
>>> with open('tests/hello-world.markdown') as f:
... post = frontmatter.loads(f.read()) | frontmatter/__init__.py | def loads(text, encoding='utf-8', handler=None, **defaults):
"""
Parse text (binary or unicode) and return a :py:class:`post <frontmatter.Post>`.
::
>>> with open('tests/hello-world.markdown') as f:
... post = frontmatter.loads(f.read())
"""
text = u(text, encoding)
handle... | def loads(text, encoding='utf-8', handler=None, **defaults):
"""
Parse text (binary or unicode) and return a :py:class:`post <frontmatter.Post>`.
::
>>> with open('tests/hello-world.markdown') as f:
... post = frontmatter.loads(f.read())
"""
text = u(text, encoding)
handle... | [
"Parse",
"text",
"(",
"binary",
"or",
"unicode",
")",
"and",
"return",
"a",
":",
"py",
":",
"class",
":",
"post",
"<frontmatter",
".",
"Post",
">",
"."
] | eyeseast/python-frontmatter | python | https://github.com/eyeseast/python-frontmatter/blob/c318e583c48599eb597e0ad59c5d972258c3febc/frontmatter/__init__.py#L117-L130 | [
"def",
"loads",
"(",
"text",
",",
"encoding",
"=",
"'utf-8'",
",",
"handler",
"=",
"None",
",",
"*",
"*",
"defaults",
")",
":",
"text",
"=",
"u",
"(",
"text",
",",
"encoding",
")",
"handler",
"=",
"handler",
"or",
"detect_format",
"(",
"text",
",",
... | c318e583c48599eb597e0ad59c5d972258c3febc |
test | dump | Serialize :py:class:`post <frontmatter.Post>` to a string and write to a file-like object.
Text will be encoded on the way out (utf-8 by default).
::
>>> from io import BytesIO
>>> f = BytesIO()
>>> frontmatter.dump(post, f)
>>> print(f.getvalue())
---
excerpt: ... | frontmatter/__init__.py | def dump(post, fd, encoding='utf-8', handler=None, **kwargs):
"""
Serialize :py:class:`post <frontmatter.Post>` to a string and write to a file-like object.
Text will be encoded on the way out (utf-8 by default).
::
>>> from io import BytesIO
>>> f = BytesIO()
>>> frontmatter.d... | def dump(post, fd, encoding='utf-8', handler=None, **kwargs):
"""
Serialize :py:class:`post <frontmatter.Post>` to a string and write to a file-like object.
Text will be encoded on the way out (utf-8 by default).
::
>>> from io import BytesIO
>>> f = BytesIO()
>>> frontmatter.d... | [
"Serialize",
":",
"py",
":",
"class",
":",
"post",
"<frontmatter",
".",
"Post",
">",
"to",
"a",
"string",
"and",
"write",
"to",
"a",
"file",
"-",
"like",
"object",
".",
"Text",
"will",
"be",
"encoded",
"on",
"the",
"way",
"out",
"(",
"utf",
"-",
"8... | eyeseast/python-frontmatter | python | https://github.com/eyeseast/python-frontmatter/blob/c318e583c48599eb597e0ad59c5d972258c3febc/frontmatter/__init__.py#L133-L159 | [
"def",
"dump",
"(",
"post",
",",
"fd",
",",
"encoding",
"=",
"'utf-8'",
",",
"handler",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"content",
"=",
"dumps",
"(",
"post",
",",
"handler",
",",
"*",
"*",
"kwargs",
")",
"if",
"hasattr",
"(",
"fd"... | c318e583c48599eb597e0ad59c5d972258c3febc |
test | dumps | Serialize a :py:class:`post <frontmatter.Post>` to a string and return text.
This always returns unicode text, which can then be encoded.
Passing ``handler`` will change how metadata is turned into text. A handler
passed as an argument will override ``post.handler``, with
:py:class:`YAMLHandler <fron... | frontmatter/__init__.py | def dumps(post, handler=None, **kwargs):
"""
Serialize a :py:class:`post <frontmatter.Post>` to a string and return text.
This always returns unicode text, which can then be encoded.
Passing ``handler`` will change how metadata is turned into text. A handler
passed as an argument will override ``p... | def dumps(post, handler=None, **kwargs):
"""
Serialize a :py:class:`post <frontmatter.Post>` to a string and return text.
This always returns unicode text, which can then be encoded.
Passing ``handler`` will change how metadata is turned into text. A handler
passed as an argument will override ``p... | [
"Serialize",
"a",
":",
"py",
":",
"class",
":",
"post",
"<frontmatter",
".",
"Post",
">",
"to",
"a",
"string",
"and",
"return",
"text",
".",
"This",
"always",
"returns",
"unicode",
"text",
"which",
"can",
"then",
"be",
"encoded",
"."
] | eyeseast/python-frontmatter | python | https://github.com/eyeseast/python-frontmatter/blob/c318e583c48599eb597e0ad59c5d972258c3febc/frontmatter/__init__.py#L162-L193 | [
"def",
"dumps",
"(",
"post",
",",
"handler",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"handler",
"is",
"None",
":",
"handler",
"=",
"getattr",
"(",
"post",
",",
"'handler'",
",",
"None",
")",
"or",
"YAMLHandler",
"(",
")",
"start_delimit... | c318e583c48599eb597e0ad59c5d972258c3febc |
test | Post.to_dict | Post as a dict, for serializing | frontmatter/__init__.py | def to_dict(self):
"Post as a dict, for serializing"
d = self.metadata.copy()
d['content'] = self.content
return d | def to_dict(self):
"Post as a dict, for serializing"
d = self.metadata.copy()
d['content'] = self.content
return d | [
"Post",
"as",
"a",
"dict",
"for",
"serializing"
] | eyeseast/python-frontmatter | python | https://github.com/eyeseast/python-frontmatter/blob/c318e583c48599eb597e0ad59c5d972258c3febc/frontmatter/__init__.py#L249-L253 | [
"def",
"to_dict",
"(",
"self",
")",
":",
"d",
"=",
"self",
".",
"metadata",
".",
"copy",
"(",
")",
"d",
"[",
"'content'",
"]",
"=",
"self",
".",
"content",
"return",
"d"
] | c318e583c48599eb597e0ad59c5d972258c3febc |
test | YAMLHandler.load | Parse YAML front matter. This uses yaml.SafeLoader by default. | frontmatter/default_handlers.py | def load(self, fm, **kwargs):
"""
Parse YAML front matter. This uses yaml.SafeLoader by default.
"""
kwargs.setdefault('Loader', SafeLoader)
return yaml.load(fm, **kwargs) | def load(self, fm, **kwargs):
"""
Parse YAML front matter. This uses yaml.SafeLoader by default.
"""
kwargs.setdefault('Loader', SafeLoader)
return yaml.load(fm, **kwargs) | [
"Parse",
"YAML",
"front",
"matter",
".",
"This",
"uses",
"yaml",
".",
"SafeLoader",
"by",
"default",
"."
] | eyeseast/python-frontmatter | python | https://github.com/eyeseast/python-frontmatter/blob/c318e583c48599eb597e0ad59c5d972258c3febc/frontmatter/default_handlers.py#L202-L207 | [
"def",
"load",
"(",
"self",
",",
"fm",
",",
"*",
"*",
"kwargs",
")",
":",
"kwargs",
".",
"setdefault",
"(",
"'Loader'",
",",
"SafeLoader",
")",
"return",
"yaml",
".",
"load",
"(",
"fm",
",",
"*",
"*",
"kwargs",
")"
] | c318e583c48599eb597e0ad59c5d972258c3febc |
test | YAMLHandler.export | Export metadata as YAML. This uses yaml.SafeDumper by default. | frontmatter/default_handlers.py | def export(self, metadata, **kwargs):
"""
Export metadata as YAML. This uses yaml.SafeDumper by default.
"""
kwargs.setdefault('Dumper', SafeDumper)
kwargs.setdefault('default_flow_style', False)
kwargs.setdefault('allow_unicode', True)
metadata = yaml.dump(metad... | def export(self, metadata, **kwargs):
"""
Export metadata as YAML. This uses yaml.SafeDumper by default.
"""
kwargs.setdefault('Dumper', SafeDumper)
kwargs.setdefault('default_flow_style', False)
kwargs.setdefault('allow_unicode', True)
metadata = yaml.dump(metad... | [
"Export",
"metadata",
"as",
"YAML",
".",
"This",
"uses",
"yaml",
".",
"SafeDumper",
"by",
"default",
"."
] | eyeseast/python-frontmatter | python | https://github.com/eyeseast/python-frontmatter/blob/c318e583c48599eb597e0ad59c5d972258c3febc/frontmatter/default_handlers.py#L209-L218 | [
"def",
"export",
"(",
"self",
",",
"metadata",
",",
"*",
"*",
"kwargs",
")",
":",
"kwargs",
".",
"setdefault",
"(",
"'Dumper'",
",",
"SafeDumper",
")",
"kwargs",
".",
"setdefault",
"(",
"'default_flow_style'",
",",
"False",
")",
"kwargs",
".",
"setdefault"... | c318e583c48599eb597e0ad59c5d972258c3febc |
test | JSONHandler.export | Turn metadata into JSON | frontmatter/default_handlers.py | def export(self, metadata, **kwargs):
"Turn metadata into JSON"
kwargs.setdefault('indent', 4)
metadata = json.dumps(metadata, **kwargs)
return u(metadata) | def export(self, metadata, **kwargs):
"Turn metadata into JSON"
kwargs.setdefault('indent', 4)
metadata = json.dumps(metadata, **kwargs)
return u(metadata) | [
"Turn",
"metadata",
"into",
"JSON"
] | eyeseast/python-frontmatter | python | https://github.com/eyeseast/python-frontmatter/blob/c318e583c48599eb597e0ad59c5d972258c3febc/frontmatter/default_handlers.py#L238-L242 | [
"def",
"export",
"(",
"self",
",",
"metadata",
",",
"*",
"*",
"kwargs",
")",
":",
"kwargs",
".",
"setdefault",
"(",
"'indent'",
",",
"4",
")",
"metadata",
"=",
"json",
".",
"dumps",
"(",
"metadata",
",",
"*",
"*",
"kwargs",
")",
"return",
"u",
"(",... | c318e583c48599eb597e0ad59c5d972258c3febc |
test | WikiList._match | Return the match object for the current list. | wikitextparser/_wikilist.py | def _match(self):
"""Return the match object for the current list."""
cache_match, cache_string = self._match_cache
string = self.string
if cache_string == string:
return cache_match
cache_match = fullmatch(
LIST_PATTERN_FORMAT.replace(b'{pattern}', self.p... | def _match(self):
"""Return the match object for the current list."""
cache_match, cache_string = self._match_cache
string = self.string
if cache_string == string:
return cache_match
cache_match = fullmatch(
LIST_PATTERN_FORMAT.replace(b'{pattern}', self.p... | [
"Return",
"the",
"match",
"object",
"for",
"the",
"current",
"list",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikilist.py#L53-L65 | [
"def",
"_match",
"(",
"self",
")",
":",
"cache_match",
",",
"cache_string",
"=",
"self",
".",
"_match_cache",
"string",
"=",
"self",
".",
"string",
"if",
"cache_string",
"==",
"string",
":",
"return",
"cache_match",
"cache_match",
"=",
"fullmatch",
"(",
"LIS... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiList.items | Return items as a list of strings.
Don't include sub-items and the start pattern. | wikitextparser/_wikilist.py | def items(self) -> List[str]:
"""Return items as a list of strings.
Don't include sub-items and the start pattern.
"""
items = [] # type: List[str]
append = items.append
string = self.string
match = self._match
ms = match.start()
for s, e in matc... | def items(self) -> List[str]:
"""Return items as a list of strings.
Don't include sub-items and the start pattern.
"""
items = [] # type: List[str]
append = items.append
string = self.string
match = self._match
ms = match.start()
for s, e in matc... | [
"Return",
"items",
"as",
"a",
"list",
"of",
"strings",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikilist.py#L68-L80 | [
"def",
"items",
"(",
"self",
")",
"->",
"List",
"[",
"str",
"]",
":",
"items",
"=",
"[",
"]",
"# type: List[str]",
"append",
"=",
"items",
".",
"append",
"string",
"=",
"self",
".",
"string",
"match",
"=",
"self",
".",
"_match",
"ms",
"=",
"match",
... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiList.sublists | Return the Lists inside the item with the given index.
:param i: The index if the item which its sub-lists are desired.
The performance is likely to be better if `i` is None.
:param pattern: The starting symbol for the desired sub-lists.
The `pattern` of the current list will b... | wikitextparser/_wikilist.py | def sublists(
self, i: int = None, pattern: str = None
) -> List['WikiList']:
"""Return the Lists inside the item with the given index.
:param i: The index if the item which its sub-lists are desired.
The performance is likely to be better if `i` is None.
:param pattern... | def sublists(
self, i: int = None, pattern: str = None
) -> List['WikiList']:
"""Return the Lists inside the item with the given index.
:param i: The index if the item which its sub-lists are desired.
The performance is likely to be better if `i` is None.
:param pattern... | [
"Return",
"the",
"Lists",
"inside",
"the",
"item",
"with",
"the",
"given",
"index",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikilist.py#L102-L142 | [
"def",
"sublists",
"(",
"self",
",",
"i",
":",
"int",
"=",
"None",
",",
"pattern",
":",
"str",
"=",
"None",
")",
"->",
"List",
"[",
"'WikiList'",
"]",
":",
"patterns",
"=",
"(",
"r'\\#'",
",",
"r'\\*'",
",",
"'[:;]'",
")",
"if",
"pattern",
"is",
... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiList.convert | Convert to another list type by replacing starting pattern. | wikitextparser/_wikilist.py | def convert(self, newstart: str) -> None:
"""Convert to another list type by replacing starting pattern."""
match = self._match
ms = match.start()
for s, e in reversed(match.spans('pattern')):
self[s - ms:e - ms] = newstart
self.pattern = escape(newstart) | def convert(self, newstart: str) -> None:
"""Convert to another list type by replacing starting pattern."""
match = self._match
ms = match.start()
for s, e in reversed(match.spans('pattern')):
self[s - ms:e - ms] = newstart
self.pattern = escape(newstart) | [
"Convert",
"to",
"another",
"list",
"type",
"by",
"replacing",
"starting",
"pattern",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikilist.py#L144-L150 | [
"def",
"convert",
"(",
"self",
",",
"newstart",
":",
"str",
")",
"->",
"None",
":",
"match",
"=",
"self",
".",
"_match",
"ms",
"=",
"match",
".",
"start",
"(",
")",
"for",
"s",
",",
"e",
"in",
"reversed",
"(",
"match",
".",
"spans",
"(",
"'patter... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | SubWikiTextWithArgs.arguments | Parse template content. Create self.name and self.arguments. | wikitextparser/_parser_function.py | def arguments(self) -> List[Argument]:
"""Parse template content. Create self.name and self.arguments."""
shadow = self._shadow
split_spans = self._args_matcher(shadow).spans('arg')
if not split_spans:
return []
arguments = []
arguments_append = arguments.appe... | def arguments(self) -> List[Argument]:
"""Parse template content. Create self.name and self.arguments."""
shadow = self._shadow
split_spans = self._args_matcher(shadow).spans('arg')
if not split_spans:
return []
arguments = []
arguments_append = arguments.appe... | [
"Parse",
"template",
"content",
".",
"Create",
"self",
".",
"name",
"and",
"self",
".",
"arguments",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_parser_function.py#L28-L54 | [
"def",
"arguments",
"(",
"self",
")",
"->",
"List",
"[",
"Argument",
"]",
":",
"shadow",
"=",
"self",
".",
"_shadow",
"split_spans",
"=",
"self",
".",
"_args_matcher",
"(",
"shadow",
")",
".",
"spans",
"(",
"'arg'",
")",
"if",
"not",
"split_spans",
":"... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | SubWikiTextWithArgs.lists | Return the lists in all arguments.
For performance reasons it is usually preferred to get a specific
Argument and use the `lists` method of that argument instead. | wikitextparser/_parser_function.py | def lists(self, pattern: str = None) -> List[WikiList]:
"""Return the lists in all arguments.
For performance reasons it is usually preferred to get a specific
Argument and use the `lists` method of that argument instead.
"""
return [
lst for arg in self.arguments fo... | def lists(self, pattern: str = None) -> List[WikiList]:
"""Return the lists in all arguments.
For performance reasons it is usually preferred to get a specific
Argument and use the `lists` method of that argument instead.
"""
return [
lst for arg in self.arguments fo... | [
"Return",
"the",
"lists",
"in",
"all",
"arguments",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_parser_function.py#L56-L63 | [
"def",
"lists",
"(",
"self",
",",
"pattern",
":",
"str",
"=",
"None",
")",
"->",
"List",
"[",
"WikiList",
"]",
":",
"return",
"[",
"lst",
"for",
"arg",
"in",
"self",
".",
"arguments",
"for",
"lst",
"in",
"arg",
".",
"lists",
"(",
"pattern",
")",
... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | SubWikiTextWithArgs.name | Return template's name (includes whitespace). | wikitextparser/_parser_function.py | def name(self) -> str:
"""Return template's name (includes whitespace)."""
h = self._atomic_partition(self._first_arg_sep)[0]
if len(h) == len(self.string):
return h[2:-2]
return h[2:] | def name(self) -> str:
"""Return template's name (includes whitespace)."""
h = self._atomic_partition(self._first_arg_sep)[0]
if len(h) == len(self.string):
return h[2:-2]
return h[2:] | [
"Return",
"template",
"s",
"name",
"(",
"includes",
"whitespace",
")",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_parser_function.py#L66-L71 | [
"def",
"name",
"(",
"self",
")",
"->",
"str",
":",
"h",
"=",
"self",
".",
"_atomic_partition",
"(",
"self",
".",
"_first_arg_sep",
")",
"[",
"0",
"]",
"if",
"len",
"(",
"h",
")",
"==",
"len",
"(",
"self",
".",
"string",
")",
":",
"return",
"h",
... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | _plant_trie | Create a Trie out of a list of words and return an atomic regex pattern.
The corresponding Regex should match much faster than a simple Regex union. | wikitextparser/_config.py | def _plant_trie(strings: _List[str]) -> dict:
"""Create a Trie out of a list of words and return an atomic regex pattern.
The corresponding Regex should match much faster than a simple Regex union.
"""
# plant the trie
trie = {}
for string in strings:
d = trie
for char in string... | def _plant_trie(strings: _List[str]) -> dict:
"""Create a Trie out of a list of words and return an atomic regex pattern.
The corresponding Regex should match much faster than a simple Regex union.
"""
# plant the trie
trie = {}
for string in strings:
d = trie
for char in string... | [
"Create",
"a",
"Trie",
"out",
"of",
"a",
"list",
"of",
"words",
"and",
"return",
"an",
"atomic",
"regex",
"pattern",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_config.py#L8-L21 | [
"def",
"_plant_trie",
"(",
"strings",
":",
"_List",
"[",
"str",
"]",
")",
"->",
"dict",
":",
"# plant the trie",
"trie",
"=",
"{",
"}",
"for",
"string",
"in",
"strings",
":",
"d",
"=",
"trie",
"for",
"char",
"in",
"string",
":",
"d",
"[",
"char",
"... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | _pattern | Convert a trie to a regex pattern. | wikitextparser/_config.py | def _pattern(trie: dict) -> str:
"""Convert a trie to a regex pattern."""
if '' in trie:
if len(trie) == 1:
return ''
optional = True
del trie['']
else:
optional = False
subpattern_to_chars = _defaultdict(list)
for char, sub_trie in trie.items():
... | def _pattern(trie: dict) -> str:
"""Convert a trie to a regex pattern."""
if '' in trie:
if len(trie) == 1:
return ''
optional = True
del trie['']
else:
optional = False
subpattern_to_chars = _defaultdict(list)
for char, sub_trie in trie.items():
... | [
"Convert",
"a",
"trie",
"to",
"a",
"regex",
"pattern",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_config.py#L24-L60 | [
"def",
"_pattern",
"(",
"trie",
":",
"dict",
")",
"->",
"str",
":",
"if",
"''",
"in",
"trie",
":",
"if",
"len",
"(",
"trie",
")",
"==",
"1",
":",
"return",
"''",
"optional",
"=",
"True",
"del",
"trie",
"[",
"''",
"]",
"else",
":",
"optional",
"... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText._check_index | Return adjusted start and stop index as tuple.
Used in __setitem__ and __delitem__. | wikitextparser/_wikitext.py | def _check_index(self, key: Union[slice, int]) -> (int, int):
"""Return adjusted start and stop index as tuple.
Used in __setitem__ and __delitem__.
"""
ss, se = self._span
if isinstance(key, int):
if key < 0:
key += se - ss
if key < ... | def _check_index(self, key: Union[slice, int]) -> (int, int):
"""Return adjusted start and stop index as tuple.
Used in __setitem__ and __delitem__.
"""
ss, se = self._span
if isinstance(key, int):
if key < 0:
key += se - ss
if key < ... | [
"Return",
"adjusted",
"start",
"and",
"stop",
"index",
"as",
"tuple",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L171-L202 | [
"def",
"_check_index",
"(",
"self",
",",
"key",
":",
"Union",
"[",
"slice",
",",
"int",
"]",
")",
"->",
"(",
"int",
",",
"int",
")",
":",
"ss",
",",
"se",
"=",
"self",
".",
"_span",
"if",
"isinstance",
"(",
"key",
",",
"int",
")",
":",
"if",
... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText.insert | Insert the given string before the specified index.
This method has the same effect as ``self[index:index] = string``;
it only avoids some condition checks as it rules out the possibility
of the key being an slice, or the need to shrink any of the sub-spans.
If parse is False, don't pa... | wikitextparser/_wikitext.py | def insert(self, index: int, string: str) -> None:
"""Insert the given string before the specified index.
This method has the same effect as ``self[index:index] = string``;
it only avoids some condition checks as it rules out the possibility
of the key being an slice, or the need to shr... | def insert(self, index: int, string: str) -> None:
"""Insert the given string before the specified index.
This method has the same effect as ``self[index:index] = string``;
it only avoids some condition checks as it rules out the possibility
of the key being an slice, or the need to shr... | [
"Insert",
"the",
"given",
"string",
"before",
"the",
"specified",
"index",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L257-L289 | [
"def",
"insert",
"(",
"self",
",",
"index",
":",
"int",
",",
"string",
":",
"str",
")",
"->",
"None",
":",
"ss",
",",
"se",
"=",
"self",
".",
"_span",
"lststr",
"=",
"self",
".",
"_lststr",
"lststr0",
"=",
"lststr",
"[",
"0",
"]",
"if",
"index",
... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText.string | Return str(self). | wikitextparser/_wikitext.py | def string(self) -> str:
"""Return str(self)."""
start, end = self._span
return self._lststr[0][start:end] | def string(self) -> str:
"""Return str(self)."""
start, end = self._span
return self._lststr[0][start:end] | [
"Return",
"str",
"(",
"self",
")",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L297-L300 | [
"def",
"string",
"(",
"self",
")",
"->",
"str",
":",
"start",
",",
"end",
"=",
"self",
".",
"_span",
"return",
"self",
".",
"_lststr",
"[",
"0",
"]",
"[",
"start",
":",
"end",
"]"
] | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText._atomic_partition | Partition self.string where `char`'s not in atomic sub-spans. | wikitextparser/_wikitext.py | def _atomic_partition(self, char: int) -> Tuple[str, str, str]:
"""Partition self.string where `char`'s not in atomic sub-spans."""
s, e = self._span
index = self._shadow.find(char)
if index == -1:
return self._lststr[0][s:e], '', ''
lststr0 = self._lststr[0]
... | def _atomic_partition(self, char: int) -> Tuple[str, str, str]:
"""Partition self.string where `char`'s not in atomic sub-spans."""
s, e = self._span
index = self._shadow.find(char)
if index == -1:
return self._lststr[0][s:e], '', ''
lststr0 = self._lststr[0]
... | [
"Partition",
"self",
".",
"string",
"where",
"char",
"s",
"not",
"in",
"atomic",
"sub",
"-",
"spans",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L312-L319 | [
"def",
"_atomic_partition",
"(",
"self",
",",
"char",
":",
"int",
")",
"->",
"Tuple",
"[",
"str",
",",
"str",
",",
"str",
"]",
":",
"s",
",",
"e",
"=",
"self",
".",
"_span",
"index",
"=",
"self",
".",
"_shadow",
".",
"find",
"(",
"char",
")",
"... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText._subspans | Return all the sub-span including self._span. | wikitextparser/_wikitext.py | def _subspans(self, type_: str) -> List[List[int]]:
"""Return all the sub-span including self._span."""
return self._type_to_spans[type_] | def _subspans(self, type_: str) -> List[List[int]]:
"""Return all the sub-span including self._span."""
return self._type_to_spans[type_] | [
"Return",
"all",
"the",
"sub",
"-",
"span",
"including",
"self",
".",
"_span",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L321-L323 | [
"def",
"_subspans",
"(",
"self",
",",
"type_",
":",
"str",
")",
"->",
"List",
"[",
"List",
"[",
"int",
"]",
"]",
":",
"return",
"self",
".",
"_type_to_spans",
"[",
"type_",
"]"
] | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText._close_subspans | Close all sub-spans of (start, stop). | wikitextparser/_wikitext.py | def _close_subspans(self, start: int, stop: int) -> None:
"""Close all sub-spans of (start, stop)."""
ss, se = self._span
for spans in self._type_to_spans.values():
b = bisect(spans, [start])
for i, (s, e) in enumerate(spans[b:bisect(spans, [stop], b)]):
i... | def _close_subspans(self, start: int, stop: int) -> None:
"""Close all sub-spans of (start, stop)."""
ss, se = self._span
for spans in self._type_to_spans.values():
b = bisect(spans, [start])
for i, (s, e) in enumerate(spans[b:bisect(spans, [stop], b)]):
i... | [
"Close",
"all",
"sub",
"-",
"spans",
"of",
"(",
"start",
"stop",
")",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L325-L334 | [
"def",
"_close_subspans",
"(",
"self",
",",
"start",
":",
"int",
",",
"stop",
":",
"int",
")",
"->",
"None",
":",
"ss",
",",
"se",
"=",
"self",
".",
"_span",
"for",
"spans",
"in",
"self",
".",
"_type_to_spans",
".",
"values",
"(",
")",
":",
"b",
... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText._shrink_update | Update self._type_to_spans according to the removed span.
Warning: If an operation involves both _shrink_update and
_insert_update, you might wanna consider doing the
_insert_update before the _shrink_update as this function
can cause data loss in self._type_to_spans. | wikitextparser/_wikitext.py | def _shrink_update(self, rmstart: int, rmstop: int) -> None:
"""Update self._type_to_spans according to the removed span.
Warning: If an operation involves both _shrink_update and
_insert_update, you might wanna consider doing the
_insert_update before the _shrink_update as this functio... | def _shrink_update(self, rmstart: int, rmstop: int) -> None:
"""Update self._type_to_spans according to the removed span.
Warning: If an operation involves both _shrink_update and
_insert_update, you might wanna consider doing the
_insert_update before the _shrink_update as this functio... | [
"Update",
"self",
".",
"_type_to_spans",
"according",
"to",
"the",
"removed",
"span",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L336-L392 | [
"def",
"_shrink_update",
"(",
"self",
",",
"rmstart",
":",
"int",
",",
"rmstop",
":",
"int",
")",
"->",
"None",
":",
"# Note: The following algorithm won't work correctly if spans",
"# are not sorted.",
"# Note: No span should be removed from _type_to_spans.",
"for",
"spans",... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText._insert_update | Update self._type_to_spans according to the added length. | wikitextparser/_wikitext.py | def _insert_update(self, index: int, length: int) -> None:
"""Update self._type_to_spans according to the added length."""
ss, se = self._span
for spans in self._type_to_spans.values():
for span in spans:
if index < span[1] or span[1] == index == se:
... | def _insert_update(self, index: int, length: int) -> None:
"""Update self._type_to_spans according to the added length."""
ss, se = self._span
for spans in self._type_to_spans.values():
for span in spans:
if index < span[1] or span[1] == index == se:
... | [
"Update",
"self",
".",
"_type_to_spans",
"according",
"to",
"the",
"added",
"length",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L394-L403 | [
"def",
"_insert_update",
"(",
"self",
",",
"index",
":",
"int",
",",
"length",
":",
"int",
")",
"->",
"None",
":",
"ss",
",",
"se",
"=",
"self",
".",
"_span",
"for",
"spans",
"in",
"self",
".",
"_type_to_spans",
".",
"values",
"(",
")",
":",
"for",... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText.nesting_level | Return the nesting level of self.
The minimum nesting_level is 0. Being part of any Template or
ParserFunction increases the level by one. | wikitextparser/_wikitext.py | def nesting_level(self) -> int:
"""Return the nesting level of self.
The minimum nesting_level is 0. Being part of any Template or
ParserFunction increases the level by one.
"""
ss, se = self._span
level = 0
type_to_spans = self._type_to_spans
for type_ i... | def nesting_level(self) -> int:
"""Return the nesting level of self.
The minimum nesting_level is 0. Being part of any Template or
ParserFunction increases the level by one.
"""
ss, se = self._span
level = 0
type_to_spans = self._type_to_spans
for type_ i... | [
"Return",
"the",
"nesting",
"level",
"of",
"self",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L406-L420 | [
"def",
"nesting_level",
"(",
"self",
")",
"->",
"int",
":",
"ss",
",",
"se",
"=",
"self",
".",
"_span",
"level",
"=",
"0",
"type_to_spans",
"=",
"self",
".",
"_type_to_spans",
"for",
"type_",
"in",
"(",
"'Template'",
",",
"'ParserFunction'",
")",
":",
... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText._shadow | Return a copy of self.string with specific sub-spans replaced.
Comments blocks are replaced by spaces. Other sub-spans are replaced
by underscores.
The replaced sub-spans are: (
'Template', 'WikiLink', 'ParserFunction', 'ExtensionTag',
'Comment',
)
This... | wikitextparser/_wikitext.py | def _shadow(self) -> bytearray:
"""Return a copy of self.string with specific sub-spans replaced.
Comments blocks are replaced by spaces. Other sub-spans are replaced
by underscores.
The replaced sub-spans are: (
'Template', 'WikiLink', 'ParserFunction', 'ExtensionTag',
... | def _shadow(self) -> bytearray:
"""Return a copy of self.string with specific sub-spans replaced.
Comments blocks are replaced by spaces. Other sub-spans are replaced
by underscores.
The replaced sub-spans are: (
'Template', 'WikiLink', 'ParserFunction', 'ExtensionTag',
... | [
"Return",
"a",
"copy",
"of",
"self",
".",
"string",
"with",
"specific",
"sub",
"-",
"spans",
"replaced",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L423-L460 | [
"def",
"_shadow",
"(",
"self",
")",
"->",
"bytearray",
":",
"ss",
",",
"se",
"=",
"self",
".",
"_span",
"string",
"=",
"self",
".",
"_lststr",
"[",
"0",
"]",
"[",
"ss",
":",
"se",
"]",
"cached_string",
",",
"shadow",
"=",
"getattr",
"(",
"self",
... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText._ext_link_shadow | Replace the invalid chars of SPAN_PARSER_TYPES with b'_'.
For comments, all characters are replaced, but for ('Template',
'ParserFunction', 'Parameter') only invalid characters are replaced. | wikitextparser/_wikitext.py | def _ext_link_shadow(self):
"""Replace the invalid chars of SPAN_PARSER_TYPES with b'_'.
For comments, all characters are replaced, but for ('Template',
'ParserFunction', 'Parameter') only invalid characters are replaced.
"""
ss, se = self._span
string = self._lststr[0][... | def _ext_link_shadow(self):
"""Replace the invalid chars of SPAN_PARSER_TYPES with b'_'.
For comments, all characters are replaced, but for ('Template',
'ParserFunction', 'Parameter') only invalid characters are replaced.
"""
ss, se = self._span
string = self._lststr[0][... | [
"Replace",
"the",
"invalid",
"chars",
"of",
"SPAN_PARSER_TYPES",
"with",
"b",
"_",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L463-L479 | [
"def",
"_ext_link_shadow",
"(",
"self",
")",
":",
"ss",
",",
"se",
"=",
"self",
".",
"_span",
"string",
"=",
"self",
".",
"_lststr",
"[",
"0",
"]",
"[",
"ss",
":",
"se",
"]",
"byte_array",
"=",
"bytearray",
"(",
"string",
",",
"'ascii'",
",",
"'rep... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText._pp_type_to_spans | Create the arguments for the parse function used in pformat method.
Only return sub-spans and change the them to fit the new scope, i.e
self.string. | wikitextparser/_wikitext.py | def _pp_type_to_spans(self) -> Dict[str, List[List[int]]]:
"""Create the arguments for the parse function used in pformat method.
Only return sub-spans and change the them to fit the new scope, i.e
self.string.
"""
ss, se = self._span
if ss == 0 and se == len(self._lstst... | def _pp_type_to_spans(self) -> Dict[str, List[List[int]]]:
"""Create the arguments for the parse function used in pformat method.
Only return sub-spans and change the them to fit the new scope, i.e
self.string.
"""
ss, se = self._span
if ss == 0 and se == len(self._lstst... | [
"Create",
"the",
"arguments",
"for",
"the",
"parse",
"function",
"used",
"in",
"pformat",
"method",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L481-L494 | [
"def",
"_pp_type_to_spans",
"(",
"self",
")",
"->",
"Dict",
"[",
"str",
",",
"List",
"[",
"List",
"[",
"int",
"]",
"]",
"]",
":",
"ss",
",",
"se",
"=",
"self",
".",
"_span",
"if",
"ss",
"==",
"0",
"and",
"se",
"==",
"len",
"(",
"self",
".",
"... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText.pprint | Deprecated, use self.pformat instead. | wikitextparser/_wikitext.py | def pprint(self, indent: str = ' ', remove_comments=False):
"""Deprecated, use self.pformat instead."""
warn(
'pprint method is deprecated, use pformat instead.',
DeprecationWarning,
)
return self.pformat(indent, remove_comments) | def pprint(self, indent: str = ' ', remove_comments=False):
"""Deprecated, use self.pformat instead."""
warn(
'pprint method is deprecated, use pformat instead.',
DeprecationWarning,
)
return self.pformat(indent, remove_comments) | [
"Deprecated",
"use",
"self",
".",
"pformat",
"instead",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L496-L502 | [
"def",
"pprint",
"(",
"self",
",",
"indent",
":",
"str",
"=",
"' '",
",",
"remove_comments",
"=",
"False",
")",
":",
"warn",
"(",
"'pprint method is deprecated, use pformat instead.'",
",",
"DeprecationWarning",
",",
")",
"return",
"self",
".",
"pformat",
"("... | 1347425814361d7955342c53212edbb27f0ff4b5 |
test | WikiText.pformat | Return a pretty-print of self.string as string.
Try to organize templates and parser functions by indenting, aligning
at the equal signs, and adding space where appropriate.
Note that this function will not mutate self. | wikitextparser/_wikitext.py | def pformat(self, indent: str = ' ', remove_comments=False) -> str:
"""Return a pretty-print of self.string as string.
Try to organize templates and parser functions by indenting, aligning
at the equal signs, and adding space where appropriate.
Note that this function will not mutat... | def pformat(self, indent: str = ' ', remove_comments=False) -> str:
"""Return a pretty-print of self.string as string.
Try to organize templates and parser functions by indenting, aligning
at the equal signs, and adding space where appropriate.
Note that this function will not mutat... | [
"Return",
"a",
"pretty",
"-",
"print",
"of",
"self",
".",
"string",
"as",
"string",
"."
] | 5j9/wikitextparser | python | https://github.com/5j9/wikitextparser/blob/1347425814361d7955342c53212edbb27f0ff4b5/wikitextparser/_wikitext.py#L504-L684 | [
"def",
"pformat",
"(",
"self",
",",
"indent",
":",
"str",
"=",
"' '",
",",
"remove_comments",
"=",
"False",
")",
"->",
"str",
":",
"ws",
"=",
"WS",
"# Do not try to do inplace pformat. It will overwrite on some spans.",
"string",
"=",
"self",
".",
"string",
"... | 1347425814361d7955342c53212edbb27f0ff4b5 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.