repo
stringlengths 7
55
| path
stringlengths 4
127
| func_name
stringlengths 1
88
| original_string
stringlengths 75
19.8k
| language
stringclasses 1
value | code
stringlengths 75
19.8k
| code_tokens
sequence | docstring
stringlengths 3
17.3k
| docstring_tokens
sequence | sha
stringlengths 40
40
| url
stringlengths 87
242
| partition
stringclasses 1
value |
|---|---|---|---|---|---|---|---|---|---|---|---|
lambdamusic/Ontospy | ontospy/extras/hacks/matcher.py | matcher | def matcher(graph1, graph2, confidence=0.5, output_file="matching_results.csv", class_or_prop="classes", verbose=False):
"""
takes two graphs and matches its classes based on qname, label etc..
@todo extend to properties and skos etc..
"""
printDebug("----------\nNow matching...")
f = open(output_file, 'wt')
counter = 0
try:
writer = csv.writer(f, quoting=csv.QUOTE_NONNUMERIC)
writer.writerow( ('name 1', 'name 2', 'uri 1', 'uri 2') )
# a) match classes
if class_or_prop == "classes":
for x in graph1.all_classes:
l1 = unicode(x.bestLabel(qname_allowed=True))
for y in graph2.all_classes:
l2 = unicode(y.bestLabel(qname_allowed=True))
if similar(l1, l2) > confidence:
counter += 1
row = [l1, l2, x.uri, y.uri]
writer.writerow([s.encode('utf8') if type(s) is unicode else s for s in row])
if verbose:
print("%s ==~== %s" % (l1, l2))
# b) match properties
elif class_or_prop == "properties":
for x in graph1.all_properties:
l1 = unicode(x.bestLabel(qname_allowed=True))
for y in graph2.all_properties:
l2 = unicode(y.bestLabel(qname_allowed=True))
if similar(l1, l2) > confidence:
counter += 1
row = [l1, l2, x.uri, y.uri]
writer.writerow([s.encode('utf8') if type(s) is unicode else s for s in row])
if verbose:
print("%s ==~== %s" % (l1, l2))
finally:
f.close()
printDebug("%d candidates found." % counter) | python | def matcher(graph1, graph2, confidence=0.5, output_file="matching_results.csv", class_or_prop="classes", verbose=False):
"""
takes two graphs and matches its classes based on qname, label etc..
@todo extend to properties and skos etc..
"""
printDebug("----------\nNow matching...")
f = open(output_file, 'wt')
counter = 0
try:
writer = csv.writer(f, quoting=csv.QUOTE_NONNUMERIC)
writer.writerow( ('name 1', 'name 2', 'uri 1', 'uri 2') )
# a) match classes
if class_or_prop == "classes":
for x in graph1.all_classes:
l1 = unicode(x.bestLabel(qname_allowed=True))
for y in graph2.all_classes:
l2 = unicode(y.bestLabel(qname_allowed=True))
if similar(l1, l2) > confidence:
counter += 1
row = [l1, l2, x.uri, y.uri]
writer.writerow([s.encode('utf8') if type(s) is unicode else s for s in row])
if verbose:
print("%s ==~== %s" % (l1, l2))
# b) match properties
elif class_or_prop == "properties":
for x in graph1.all_properties:
l1 = unicode(x.bestLabel(qname_allowed=True))
for y in graph2.all_properties:
l2 = unicode(y.bestLabel(qname_allowed=True))
if similar(l1, l2) > confidence:
counter += 1
row = [l1, l2, x.uri, y.uri]
writer.writerow([s.encode('utf8') if type(s) is unicode else s for s in row])
if verbose:
print("%s ==~== %s" % (l1, l2))
finally:
f.close()
printDebug("%d candidates found." % counter) | [
"def",
"matcher",
"(",
"graph1",
",",
"graph2",
",",
"confidence",
"=",
"0.5",
",",
"output_file",
"=",
"\"matching_results.csv\"",
",",
"class_or_prop",
"=",
"\"classes\"",
",",
"verbose",
"=",
"False",
")",
":",
"printDebug",
"(",
"\"----------\\nNow matching...\"",
")",
"f",
"=",
"open",
"(",
"output_file",
",",
"'wt'",
")",
"counter",
"=",
"0",
"try",
":",
"writer",
"=",
"csv",
".",
"writer",
"(",
"f",
",",
"quoting",
"=",
"csv",
".",
"QUOTE_NONNUMERIC",
")",
"writer",
".",
"writerow",
"(",
"(",
"'name 1'",
",",
"'name 2'",
",",
"'uri 1'",
",",
"'uri 2'",
")",
")",
"# a) match classes",
"if",
"class_or_prop",
"==",
"\"classes\"",
":",
"for",
"x",
"in",
"graph1",
".",
"all_classes",
":",
"l1",
"=",
"unicode",
"(",
"x",
".",
"bestLabel",
"(",
"qname_allowed",
"=",
"True",
")",
")",
"for",
"y",
"in",
"graph2",
".",
"all_classes",
":",
"l2",
"=",
"unicode",
"(",
"y",
".",
"bestLabel",
"(",
"qname_allowed",
"=",
"True",
")",
")",
"if",
"similar",
"(",
"l1",
",",
"l2",
")",
">",
"confidence",
":",
"counter",
"+=",
"1",
"row",
"=",
"[",
"l1",
",",
"l2",
",",
"x",
".",
"uri",
",",
"y",
".",
"uri",
"]",
"writer",
".",
"writerow",
"(",
"[",
"s",
".",
"encode",
"(",
"'utf8'",
")",
"if",
"type",
"(",
"s",
")",
"is",
"unicode",
"else",
"s",
"for",
"s",
"in",
"row",
"]",
")",
"if",
"verbose",
":",
"print",
"(",
"\"%s ==~== %s\"",
"%",
"(",
"l1",
",",
"l2",
")",
")",
"# b) match properties",
"elif",
"class_or_prop",
"==",
"\"properties\"",
":",
"for",
"x",
"in",
"graph1",
".",
"all_properties",
":",
"l1",
"=",
"unicode",
"(",
"x",
".",
"bestLabel",
"(",
"qname_allowed",
"=",
"True",
")",
")",
"for",
"y",
"in",
"graph2",
".",
"all_properties",
":",
"l2",
"=",
"unicode",
"(",
"y",
".",
"bestLabel",
"(",
"qname_allowed",
"=",
"True",
")",
")",
"if",
"similar",
"(",
"l1",
",",
"l2",
")",
">",
"confidence",
":",
"counter",
"+=",
"1",
"row",
"=",
"[",
"l1",
",",
"l2",
",",
"x",
".",
"uri",
",",
"y",
".",
"uri",
"]",
"writer",
".",
"writerow",
"(",
"[",
"s",
".",
"encode",
"(",
"'utf8'",
")",
"if",
"type",
"(",
"s",
")",
"is",
"unicode",
"else",
"s",
"for",
"s",
"in",
"row",
"]",
")",
"if",
"verbose",
":",
"print",
"(",
"\"%s ==~== %s\"",
"%",
"(",
"l1",
",",
"l2",
")",
")",
"finally",
":",
"f",
".",
"close",
"(",
")",
"printDebug",
"(",
"\"%d candidates found.\"",
"%",
"counter",
")"
] | takes two graphs and matches its classes based on qname, label etc..
@todo extend to properties and skos etc.. | [
"takes",
"two",
"graphs",
"and",
"matches",
"its",
"classes",
"based",
"on",
"qname",
"label",
"etc",
".."
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/extras/hacks/matcher.py#L69-L122 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | safe_str | def safe_str(u, errors="replace"):
"""Safely print the given string.
If you want to see the code points for unprintable characters then you
can use `errors="xmlcharrefreplace"`.
http://code.activestate.com/recipes/576602-safe-print/
"""
s = u.encode(sys.stdout.encoding or "utf-8", errors)
return s | python | def safe_str(u, errors="replace"):
"""Safely print the given string.
If you want to see the code points for unprintable characters then you
can use `errors="xmlcharrefreplace"`.
http://code.activestate.com/recipes/576602-safe-print/
"""
s = u.encode(sys.stdout.encoding or "utf-8", errors)
return s | [
"def",
"safe_str",
"(",
"u",
",",
"errors",
"=",
"\"replace\"",
")",
":",
"s",
"=",
"u",
".",
"encode",
"(",
"sys",
".",
"stdout",
".",
"encoding",
"or",
"\"utf-8\"",
",",
"errors",
")",
"return",
"s"
] | Safely print the given string.
If you want to see the code points for unprintable characters then you
can use `errors="xmlcharrefreplace"`.
http://code.activestate.com/recipes/576602-safe-print/ | [
"Safely",
"print",
"the",
"given",
"string",
"."
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L41-L49 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | OLD_printDebug | def OLD_printDebug(s, style=None):
"""
util for printing in colors to sys.stderr stream
"""
if style == "comment":
s = Style.DIM + s + Style.RESET_ALL
elif style == "important":
s = Style.BRIGHT + s + Style.RESET_ALL
elif style == "normal":
s = Style.RESET_ALL + s + Style.RESET_ALL
elif style == "red":
s = Fore.RED + s + Style.RESET_ALL
elif style == "green":
s = Fore.GREEN + s + Style.RESET_ALL
try:
print(s, file=sys.stderr)
except:
pass | python | def OLD_printDebug(s, style=None):
"""
util for printing in colors to sys.stderr stream
"""
if style == "comment":
s = Style.DIM + s + Style.RESET_ALL
elif style == "important":
s = Style.BRIGHT + s + Style.RESET_ALL
elif style == "normal":
s = Style.RESET_ALL + s + Style.RESET_ALL
elif style == "red":
s = Fore.RED + s + Style.RESET_ALL
elif style == "green":
s = Fore.GREEN + s + Style.RESET_ALL
try:
print(s, file=sys.stderr)
except:
pass | [
"def",
"OLD_printDebug",
"(",
"s",
",",
"style",
"=",
"None",
")",
":",
"if",
"style",
"==",
"\"comment\"",
":",
"s",
"=",
"Style",
".",
"DIM",
"+",
"s",
"+",
"Style",
".",
"RESET_ALL",
"elif",
"style",
"==",
"\"important\"",
":",
"s",
"=",
"Style",
".",
"BRIGHT",
"+",
"s",
"+",
"Style",
".",
"RESET_ALL",
"elif",
"style",
"==",
"\"normal\"",
":",
"s",
"=",
"Style",
".",
"RESET_ALL",
"+",
"s",
"+",
"Style",
".",
"RESET_ALL",
"elif",
"style",
"==",
"\"red\"",
":",
"s",
"=",
"Fore",
".",
"RED",
"+",
"s",
"+",
"Style",
".",
"RESET_ALL",
"elif",
"style",
"==",
"\"green\"",
":",
"s",
"=",
"Fore",
".",
"GREEN",
"+",
"s",
"+",
"Style",
".",
"RESET_ALL",
"try",
":",
"print",
"(",
"s",
",",
"file",
"=",
"sys",
".",
"stderr",
")",
"except",
":",
"pass"
] | util for printing in colors to sys.stderr stream | [
"util",
"for",
"printing",
"in",
"colors",
"to",
"sys",
".",
"stderr",
"stream"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L175-L192 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | pprint2columns | def pprint2columns(llist, max_length=60):
"""
llist = a list of strings
max_length = if a word is longer than that, for single col display
> prints a list in two columns, taking care of alignment too
"""
if len(llist) == 0:
return None
col_width = max(len(word) for word in llist) + 2 # padding
# llist length must be even, otherwise splitting fails
if not len(llist) % 2 == 0:
llist += [' '] # add a fake element
if col_width > max_length:
for el in llist:
print(el)
else:
column1 = llist[:int(len(llist) / 2)]
column2 = llist[int(len(llist) / 2):]
for c1, c2 in zip(column1, column2):
space = " " * (col_width - len(c1))
print("%s%s%s" % (c1, space, c2)) | python | def pprint2columns(llist, max_length=60):
"""
llist = a list of strings
max_length = if a word is longer than that, for single col display
> prints a list in two columns, taking care of alignment too
"""
if len(llist) == 0:
return None
col_width = max(len(word) for word in llist) + 2 # padding
# llist length must be even, otherwise splitting fails
if not len(llist) % 2 == 0:
llist += [' '] # add a fake element
if col_width > max_length:
for el in llist:
print(el)
else:
column1 = llist[:int(len(llist) / 2)]
column2 = llist[int(len(llist) / 2):]
for c1, c2 in zip(column1, column2):
space = " " * (col_width - len(c1))
print("%s%s%s" % (c1, space, c2)) | [
"def",
"pprint2columns",
"(",
"llist",
",",
"max_length",
"=",
"60",
")",
":",
"if",
"len",
"(",
"llist",
")",
"==",
"0",
":",
"return",
"None",
"col_width",
"=",
"max",
"(",
"len",
"(",
"word",
")",
"for",
"word",
"in",
"llist",
")",
"+",
"2",
"# padding",
"# llist length must be even, otherwise splitting fails",
"if",
"not",
"len",
"(",
"llist",
")",
"%",
"2",
"==",
"0",
":",
"llist",
"+=",
"[",
"' '",
"]",
"# add a fake element",
"if",
"col_width",
">",
"max_length",
":",
"for",
"el",
"in",
"llist",
":",
"print",
"(",
"el",
")",
"else",
":",
"column1",
"=",
"llist",
"[",
":",
"int",
"(",
"len",
"(",
"llist",
")",
"/",
"2",
")",
"]",
"column2",
"=",
"llist",
"[",
"int",
"(",
"len",
"(",
"llist",
")",
"/",
"2",
")",
":",
"]",
"for",
"c1",
",",
"c2",
"in",
"zip",
"(",
"column1",
",",
"column2",
")",
":",
"space",
"=",
"\" \"",
"*",
"(",
"col_width",
"-",
"len",
"(",
"c1",
")",
")",
"print",
"(",
"\"%s%s%s\"",
"%",
"(",
"c1",
",",
"space",
",",
"c2",
")",
")"
] | llist = a list of strings
max_length = if a word is longer than that, for single col display
> prints a list in two columns, taking care of alignment too | [
"llist",
"=",
"a",
"list",
"of",
"strings",
"max_length",
"=",
"if",
"a",
"word",
"is",
"longer",
"than",
"that",
"for",
"single",
"col",
"display"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L195-L219 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | playSound | def playSound(folder, name=""):
""" as easy as that """
try:
if not name:
onlyfiles = [
f for f in os.listdir(folder)
if os.path.isfile(os.path.join(folder, f))
]
name = random.choice(onlyfiles)
subprocess.call(["afplay", folder + name])
# subprocess.call(["say", "%d started, batch %d" % (adate, batch)])
except:
pass | python | def playSound(folder, name=""):
""" as easy as that """
try:
if not name:
onlyfiles = [
f for f in os.listdir(folder)
if os.path.isfile(os.path.join(folder, f))
]
name = random.choice(onlyfiles)
subprocess.call(["afplay", folder + name])
# subprocess.call(["say", "%d started, batch %d" % (adate, batch)])
except:
pass | [
"def",
"playSound",
"(",
"folder",
",",
"name",
"=",
"\"\"",
")",
":",
"try",
":",
"if",
"not",
"name",
":",
"onlyfiles",
"=",
"[",
"f",
"for",
"f",
"in",
"os",
".",
"listdir",
"(",
"folder",
")",
"if",
"os",
".",
"path",
".",
"isfile",
"(",
"os",
".",
"path",
".",
"join",
"(",
"folder",
",",
"f",
")",
")",
"]",
"name",
"=",
"random",
".",
"choice",
"(",
"onlyfiles",
")",
"subprocess",
".",
"call",
"(",
"[",
"\"afplay\"",
",",
"folder",
"+",
"name",
"]",
")",
"# subprocess.call([\"say\", \"%d started, batch %d\" % (adate, batch)])",
"except",
":",
"pass"
] | as easy as that | [
"as",
"easy",
"as",
"that"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L344-L356 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | truncate | def truncate(data, l=20):
"truncate a string"
info = (data[:l] + '..') if len(data) > l else data
return info | python | def truncate(data, l=20):
"truncate a string"
info = (data[:l] + '..') if len(data) > l else data
return info | [
"def",
"truncate",
"(",
"data",
",",
"l",
"=",
"20",
")",
":",
"info",
"=",
"(",
"data",
"[",
":",
"l",
"]",
"+",
"'..'",
")",
"if",
"len",
"(",
"data",
")",
">",
"l",
"else",
"data",
"return",
"info"
] | truncate a string | [
"truncate",
"a",
"string"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L359-L362 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | printGenericTree | def printGenericTree(element,
level=0,
showids=True,
labels=False,
showtype=True,
TYPE_MARGIN=18):
"""
Print nicely into stdout the taxonomical tree of an ontology.
Works irrespectively of whether it's a class or property.
Note: indentation is made so that ids up to 3 digits fit in, plus a space.
[123]1--
[1]123--
[12]12--
<TYPE_MARGIN> is parametrized so that classes and properties can have different default spacing (eg owl:class vs owl:AnnotationProperty)
"""
ID_MARGIN = 5
SHORT_TYPES = {
"rdf:Property": "rdf:Property",
"owl:AnnotationProperty": "owl:Annot.Pr.",
"owl:DatatypeProperty": "owl:DatatypePr.",
"owl:ObjectProperty": "owl:ObjectPr.",
}
if showids:
_id_ = Fore.BLUE + \
"[%d]%s" % (element.id, " " * (ID_MARGIN - len(str(element.id)))) + \
Fore.RESET
elif showtype:
_prop = uri2niceString(element.rdftype)
try:
prop = SHORT_TYPES[_prop]
except:
prop = _prop
_id_ = Fore.BLUE + \
"[%s]%s" % (prop, " " * (TYPE_MARGIN - len(prop))) + Fore.RESET
else:
_id_ = ""
if labels:
bestLabel = element.bestLabel(qname_allowed=False)
if bestLabel:
bestLabel = Fore.MAGENTA + " (\"%s\")" % bestLabel + Fore.RESET
else:
bestLabel = ""
printDebug("%s%s%s%s" % (_id_, "-" * 4 * level, element.qname, bestLabel))
# recursion
for sub in element.children():
printGenericTree(sub, (level + 1), showids, labels, showtype,
TYPE_MARGIN) | python | def printGenericTree(element,
level=0,
showids=True,
labels=False,
showtype=True,
TYPE_MARGIN=18):
"""
Print nicely into stdout the taxonomical tree of an ontology.
Works irrespectively of whether it's a class or property.
Note: indentation is made so that ids up to 3 digits fit in, plus a space.
[123]1--
[1]123--
[12]12--
<TYPE_MARGIN> is parametrized so that classes and properties can have different default spacing (eg owl:class vs owl:AnnotationProperty)
"""
ID_MARGIN = 5
SHORT_TYPES = {
"rdf:Property": "rdf:Property",
"owl:AnnotationProperty": "owl:Annot.Pr.",
"owl:DatatypeProperty": "owl:DatatypePr.",
"owl:ObjectProperty": "owl:ObjectPr.",
}
if showids:
_id_ = Fore.BLUE + \
"[%d]%s" % (element.id, " " * (ID_MARGIN - len(str(element.id)))) + \
Fore.RESET
elif showtype:
_prop = uri2niceString(element.rdftype)
try:
prop = SHORT_TYPES[_prop]
except:
prop = _prop
_id_ = Fore.BLUE + \
"[%s]%s" % (prop, " " * (TYPE_MARGIN - len(prop))) + Fore.RESET
else:
_id_ = ""
if labels:
bestLabel = element.bestLabel(qname_allowed=False)
if bestLabel:
bestLabel = Fore.MAGENTA + " (\"%s\")" % bestLabel + Fore.RESET
else:
bestLabel = ""
printDebug("%s%s%s%s" % (_id_, "-" * 4 * level, element.qname, bestLabel))
# recursion
for sub in element.children():
printGenericTree(sub, (level + 1), showids, labels, showtype,
TYPE_MARGIN) | [
"def",
"printGenericTree",
"(",
"element",
",",
"level",
"=",
"0",
",",
"showids",
"=",
"True",
",",
"labels",
"=",
"False",
",",
"showtype",
"=",
"True",
",",
"TYPE_MARGIN",
"=",
"18",
")",
":",
"ID_MARGIN",
"=",
"5",
"SHORT_TYPES",
"=",
"{",
"\"rdf:Property\"",
":",
"\"rdf:Property\"",
",",
"\"owl:AnnotationProperty\"",
":",
"\"owl:Annot.Pr.\"",
",",
"\"owl:DatatypeProperty\"",
":",
"\"owl:DatatypePr.\"",
",",
"\"owl:ObjectProperty\"",
":",
"\"owl:ObjectPr.\"",
",",
"}",
"if",
"showids",
":",
"_id_",
"=",
"Fore",
".",
"BLUE",
"+",
"\"[%d]%s\"",
"%",
"(",
"element",
".",
"id",
",",
"\" \"",
"*",
"(",
"ID_MARGIN",
"-",
"len",
"(",
"str",
"(",
"element",
".",
"id",
")",
")",
")",
")",
"+",
"Fore",
".",
"RESET",
"elif",
"showtype",
":",
"_prop",
"=",
"uri2niceString",
"(",
"element",
".",
"rdftype",
")",
"try",
":",
"prop",
"=",
"SHORT_TYPES",
"[",
"_prop",
"]",
"except",
":",
"prop",
"=",
"_prop",
"_id_",
"=",
"Fore",
".",
"BLUE",
"+",
"\"[%s]%s\"",
"%",
"(",
"prop",
",",
"\" \"",
"*",
"(",
"TYPE_MARGIN",
"-",
"len",
"(",
"prop",
")",
")",
")",
"+",
"Fore",
".",
"RESET",
"else",
":",
"_id_",
"=",
"\"\"",
"if",
"labels",
":",
"bestLabel",
"=",
"element",
".",
"bestLabel",
"(",
"qname_allowed",
"=",
"False",
")",
"if",
"bestLabel",
":",
"bestLabel",
"=",
"Fore",
".",
"MAGENTA",
"+",
"\" (\\\"%s\\\")\"",
"%",
"bestLabel",
"+",
"Fore",
".",
"RESET",
"else",
":",
"bestLabel",
"=",
"\"\"",
"printDebug",
"(",
"\"%s%s%s%s\"",
"%",
"(",
"_id_",
",",
"\"-\"",
"*",
"4",
"*",
"level",
",",
"element",
".",
"qname",
",",
"bestLabel",
")",
")",
"# recursion",
"for",
"sub",
"in",
"element",
".",
"children",
"(",
")",
":",
"printGenericTree",
"(",
"sub",
",",
"(",
"level",
"+",
"1",
")",
",",
"showids",
",",
"labels",
",",
"showtype",
",",
"TYPE_MARGIN",
")"
] | Print nicely into stdout the taxonomical tree of an ontology.
Works irrespectively of whether it's a class or property.
Note: indentation is made so that ids up to 3 digits fit in, plus a space.
[123]1--
[1]123--
[12]12--
<TYPE_MARGIN> is parametrized so that classes and properties can have different default spacing (eg owl:class vs owl:AnnotationProperty) | [
"Print",
"nicely",
"into",
"stdout",
"the",
"taxonomical",
"tree",
"of",
"an",
"ontology",
"."
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L443-L500 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | firstStringInList | def firstStringInList(literalEntities, prefLanguage="en"):
"""
from a list of literals, returns the one in prefLanguage
if no language specification is available, return first element
"""
match = ""
if len(literalEntities) == 1:
match = literalEntities[0]
elif len(literalEntities) > 1:
for x in literalEntities:
if getattr(x, 'language') and getattr(x,
'language') == prefLanguage:
match = x
if not match: # don't bother about language
match = literalEntities[0]
return match | python | def firstStringInList(literalEntities, prefLanguage="en"):
"""
from a list of literals, returns the one in prefLanguage
if no language specification is available, return first element
"""
match = ""
if len(literalEntities) == 1:
match = literalEntities[0]
elif len(literalEntities) > 1:
for x in literalEntities:
if getattr(x, 'language') and getattr(x,
'language') == prefLanguage:
match = x
if not match: # don't bother about language
match = literalEntities[0]
return match | [
"def",
"firstStringInList",
"(",
"literalEntities",
",",
"prefLanguage",
"=",
"\"en\"",
")",
":",
"match",
"=",
"\"\"",
"if",
"len",
"(",
"literalEntities",
")",
"==",
"1",
":",
"match",
"=",
"literalEntities",
"[",
"0",
"]",
"elif",
"len",
"(",
"literalEntities",
")",
">",
"1",
":",
"for",
"x",
"in",
"literalEntities",
":",
"if",
"getattr",
"(",
"x",
",",
"'language'",
")",
"and",
"getattr",
"(",
"x",
",",
"'language'",
")",
"==",
"prefLanguage",
":",
"match",
"=",
"x",
"if",
"not",
"match",
":",
"# don't bother about language",
"match",
"=",
"literalEntities",
"[",
"0",
"]",
"return",
"match"
] | from a list of literals, returns the one in prefLanguage
if no language specification is available, return first element | [
"from",
"a",
"list",
"of",
"literals",
"returns",
"the",
"one",
"in",
"prefLanguage",
"if",
"no",
"language",
"specification",
"is",
"available",
"return",
"first",
"element"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L503-L519 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | joinStringsInList | def joinStringsInList(literalEntities, prefLanguage="en"):
"""
from a list of literals, returns the ones in prefLanguage joined up.
if the desired language specification is not available, join all up
"""
match = []
if len(literalEntities) == 1:
return literalEntities[0]
elif len(literalEntities) > 1:
for x in literalEntities:
if getattr(x, 'language') and getattr(x,
'language') == prefLanguage:
match.append(x)
if not match: # don't bother about language
for x in literalEntities:
match.append(x)
return " - ".join([x for x in match]) | python | def joinStringsInList(literalEntities, prefLanguage="en"):
"""
from a list of literals, returns the ones in prefLanguage joined up.
if the desired language specification is not available, join all up
"""
match = []
if len(literalEntities) == 1:
return literalEntities[0]
elif len(literalEntities) > 1:
for x in literalEntities:
if getattr(x, 'language') and getattr(x,
'language') == prefLanguage:
match.append(x)
if not match: # don't bother about language
for x in literalEntities:
match.append(x)
return " - ".join([x for x in match]) | [
"def",
"joinStringsInList",
"(",
"literalEntities",
",",
"prefLanguage",
"=",
"\"en\"",
")",
":",
"match",
"=",
"[",
"]",
"if",
"len",
"(",
"literalEntities",
")",
"==",
"1",
":",
"return",
"literalEntities",
"[",
"0",
"]",
"elif",
"len",
"(",
"literalEntities",
")",
">",
"1",
":",
"for",
"x",
"in",
"literalEntities",
":",
"if",
"getattr",
"(",
"x",
",",
"'language'",
")",
"and",
"getattr",
"(",
"x",
",",
"'language'",
")",
"==",
"prefLanguage",
":",
"match",
".",
"append",
"(",
"x",
")",
"if",
"not",
"match",
":",
"# don't bother about language",
"for",
"x",
"in",
"literalEntities",
":",
"match",
".",
"append",
"(",
"x",
")",
"return",
"\" - \"",
".",
"join",
"(",
"[",
"x",
"for",
"x",
"in",
"match",
"]",
")"
] | from a list of literals, returns the ones in prefLanguage joined up.
if the desired language specification is not available, join all up | [
"from",
"a",
"list",
"of",
"literals",
"returns",
"the",
"ones",
"in",
"prefLanguage",
"joined",
"up",
".",
"if",
"the",
"desired",
"language",
"specification",
"is",
"not",
"available",
"join",
"all",
"up"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L526-L544 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | sortByNamespacePrefix | def sortByNamespacePrefix(urisList, nsList):
"""
Given an ordered list of namespaces prefixes, order a list of uris based on that.
Eg
In [7]: ll
Out[7]:
[rdflib.term.URIRef(u'http://www.w3.org/1999/02/22-rdf-syntax-ns#type'),
rdflib.term.URIRef(u'printGenericTreeorg/2000/01/rdf-schema#comment'),
rdflib.term.URIRef(u'http://www.w3.org/2000/01/rdf-schema#label'),
rdflib.term.URIRef(u'http://www.w3.org/2002/07/owl#equivalentClass')]
In [8]: sortByNamespacePrefix(ll, [OWL.OWLNS, RDFS])
Out[8]:
[rdflib.term.URIRef(u'http://www.w3.org/2002/07/owl#equivalentClass'),
rdflib.term.URIRef(u'http://www.w3.org/2000/01/rdf-schema#comment'),
rdflib.term.URIRef(u'http://www.w3.org/2000/01/rdf-schema#label'),
rdflib.term.URIRef(u'http://www.w3.org/1999/02/22-rdf-syntax-ns#type')]
"""
exit = []
urisList = sort_uri_list_by_name(urisList)
for ns in nsList:
innerexit = []
for uri in urisList:
if str(uri).startswith(str(ns)):
innerexit += [uri]
exit += innerexit
# add remaining uris (if any)
for uri in urisList:
if uri not in exit:
exit += [uri]
return exit | python | def sortByNamespacePrefix(urisList, nsList):
"""
Given an ordered list of namespaces prefixes, order a list of uris based on that.
Eg
In [7]: ll
Out[7]:
[rdflib.term.URIRef(u'http://www.w3.org/1999/02/22-rdf-syntax-ns#type'),
rdflib.term.URIRef(u'printGenericTreeorg/2000/01/rdf-schema#comment'),
rdflib.term.URIRef(u'http://www.w3.org/2000/01/rdf-schema#label'),
rdflib.term.URIRef(u'http://www.w3.org/2002/07/owl#equivalentClass')]
In [8]: sortByNamespacePrefix(ll, [OWL.OWLNS, RDFS])
Out[8]:
[rdflib.term.URIRef(u'http://www.w3.org/2002/07/owl#equivalentClass'),
rdflib.term.URIRef(u'http://www.w3.org/2000/01/rdf-schema#comment'),
rdflib.term.URIRef(u'http://www.w3.org/2000/01/rdf-schema#label'),
rdflib.term.URIRef(u'http://www.w3.org/1999/02/22-rdf-syntax-ns#type')]
"""
exit = []
urisList = sort_uri_list_by_name(urisList)
for ns in nsList:
innerexit = []
for uri in urisList:
if str(uri).startswith(str(ns)):
innerexit += [uri]
exit += innerexit
# add remaining uris (if any)
for uri in urisList:
if uri not in exit:
exit += [uri]
return exit | [
"def",
"sortByNamespacePrefix",
"(",
"urisList",
",",
"nsList",
")",
":",
"exit",
"=",
"[",
"]",
"urisList",
"=",
"sort_uri_list_by_name",
"(",
"urisList",
")",
"for",
"ns",
"in",
"nsList",
":",
"innerexit",
"=",
"[",
"]",
"for",
"uri",
"in",
"urisList",
":",
"if",
"str",
"(",
"uri",
")",
".",
"startswith",
"(",
"str",
"(",
"ns",
")",
")",
":",
"innerexit",
"+=",
"[",
"uri",
"]",
"exit",
"+=",
"innerexit",
"# add remaining uris (if any)",
"for",
"uri",
"in",
"urisList",
":",
"if",
"uri",
"not",
"in",
"exit",
":",
"exit",
"+=",
"[",
"uri",
"]",
"return",
"exit"
] | Given an ordered list of namespaces prefixes, order a list of uris based on that.
Eg
In [7]: ll
Out[7]:
[rdflib.term.URIRef(u'http://www.w3.org/1999/02/22-rdf-syntax-ns#type'),
rdflib.term.URIRef(u'printGenericTreeorg/2000/01/rdf-schema#comment'),
rdflib.term.URIRef(u'http://www.w3.org/2000/01/rdf-schema#label'),
rdflib.term.URIRef(u'http://www.w3.org/2002/07/owl#equivalentClass')]
In [8]: sortByNamespacePrefix(ll, [OWL.OWLNS, RDFS])
Out[8]:
[rdflib.term.URIRef(u'http://www.w3.org/2002/07/owl#equivalentClass'),
rdflib.term.URIRef(u'http://www.w3.org/2000/01/rdf-schema#comment'),
rdflib.term.URIRef(u'http://www.w3.org/2000/01/rdf-schema#label'),
rdflib.term.URIRef(u'http://www.w3.org/1999/02/22-rdf-syntax-ns#type')] | [
"Given",
"an",
"ordered",
"list",
"of",
"namespaces",
"prefixes",
"order",
"a",
"list",
"of",
"uris",
"based",
"on",
"that",
".",
"Eg"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L547-L581 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | sort_uri_list_by_name | def sort_uri_list_by_name(uri_list, bypassNamespace=False):
"""
Sorts a list of uris
bypassNamespace:
based on the last bit (usually the name after the namespace) of a uri
It checks whether the last bit is specified using a # or just a /, eg:
rdflib.URIRef('http://purl.org/ontology/mo/Vinyl'),
rdflib.URIRef('http://purl.org/vocab/frbr/core#Work')
"""
def get_last_bit(uri_string):
try:
x = uri_string.split("#")[1]
except:
x = uri_string.split("/")[-1]
return x
try:
if bypassNamespace:
return sorted(uri_list, key=lambda x: get_last_bit(x.__str__()))
else:
return sorted(uri_list)
except:
# TODO: do more testing.. maybe use a unicode-safe method instead of __str__
print(
"Error in <sort_uri_list_by_name>: possibly a UnicodeEncodeError")
return uri_list | python | def sort_uri_list_by_name(uri_list, bypassNamespace=False):
"""
Sorts a list of uris
bypassNamespace:
based on the last bit (usually the name after the namespace) of a uri
It checks whether the last bit is specified using a # or just a /, eg:
rdflib.URIRef('http://purl.org/ontology/mo/Vinyl'),
rdflib.URIRef('http://purl.org/vocab/frbr/core#Work')
"""
def get_last_bit(uri_string):
try:
x = uri_string.split("#")[1]
except:
x = uri_string.split("/")[-1]
return x
try:
if bypassNamespace:
return sorted(uri_list, key=lambda x: get_last_bit(x.__str__()))
else:
return sorted(uri_list)
except:
# TODO: do more testing.. maybe use a unicode-safe method instead of __str__
print(
"Error in <sort_uri_list_by_name>: possibly a UnicodeEncodeError")
return uri_list | [
"def",
"sort_uri_list_by_name",
"(",
"uri_list",
",",
"bypassNamespace",
"=",
"False",
")",
":",
"def",
"get_last_bit",
"(",
"uri_string",
")",
":",
"try",
":",
"x",
"=",
"uri_string",
".",
"split",
"(",
"\"#\"",
")",
"[",
"1",
"]",
"except",
":",
"x",
"=",
"uri_string",
".",
"split",
"(",
"\"/\"",
")",
"[",
"-",
"1",
"]",
"return",
"x",
"try",
":",
"if",
"bypassNamespace",
":",
"return",
"sorted",
"(",
"uri_list",
",",
"key",
"=",
"lambda",
"x",
":",
"get_last_bit",
"(",
"x",
".",
"__str__",
"(",
")",
")",
")",
"else",
":",
"return",
"sorted",
"(",
"uri_list",
")",
"except",
":",
"# TODO: do more testing.. maybe use a unicode-safe method instead of __str__",
"print",
"(",
"\"Error in <sort_uri_list_by_name>: possibly a UnicodeEncodeError\"",
")",
"return",
"uri_list"
] | Sorts a list of uris
bypassNamespace:
based on the last bit (usually the name after the namespace) of a uri
It checks whether the last bit is specified using a # or just a /, eg:
rdflib.URIRef('http://purl.org/ontology/mo/Vinyl'),
rdflib.URIRef('http://purl.org/vocab/frbr/core#Work') | [
"Sorts",
"a",
"list",
"of",
"uris"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L584-L612 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | inferNamespacePrefix | def inferNamespacePrefix(aUri):
"""
From a URI returns the last bit and simulates a namespace prefix when rendering the ontology.
eg from <'http://www.w3.org/2008/05/skos#'>
it returns the 'skos' string
"""
stringa = aUri.__str__()
try:
prefix = stringa.replace("#", "").split("/")[-1]
except:
prefix = ""
return prefix | python | def inferNamespacePrefix(aUri):
"""
From a URI returns the last bit and simulates a namespace prefix when rendering the ontology.
eg from <'http://www.w3.org/2008/05/skos#'>
it returns the 'skos' string
"""
stringa = aUri.__str__()
try:
prefix = stringa.replace("#", "").split("/")[-1]
except:
prefix = ""
return prefix | [
"def",
"inferNamespacePrefix",
"(",
"aUri",
")",
":",
"stringa",
"=",
"aUri",
".",
"__str__",
"(",
")",
"try",
":",
"prefix",
"=",
"stringa",
".",
"replace",
"(",
"\"#\"",
",",
"\"\"",
")",
".",
"split",
"(",
"\"/\"",
")",
"[",
"-",
"1",
"]",
"except",
":",
"prefix",
"=",
"\"\"",
"return",
"prefix"
] | From a URI returns the last bit and simulates a namespace prefix when rendering the ontology.
eg from <'http://www.w3.org/2008/05/skos#'>
it returns the 'skos' string | [
"From",
"a",
"URI",
"returns",
"the",
"last",
"bit",
"and",
"simulates",
"a",
"namespace",
"prefix",
"when",
"rendering",
"the",
"ontology",
"."
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L636-L648 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | niceString2uri | def niceString2uri(aUriString, namespaces=None):
"""
From a string representing a URI possibly with the namespace qname, returns a URI instance.
gold:Citation ==> rdflib.term.URIRef(u'http://purl.org/linguistics/gold/Citation')
Namespaces are a list
[('xml', rdflib.URIRef('http://www.w3.org/XML/1998/namespace'))
('', rdflib.URIRef('http://cohereweb.net/ontology/cohere.owl#'))
(u'owl', rdflib.URIRef('http://www.w3.org/2002/07/owl#'))
('rdfs', rdflib.URIRef('http://www.w3.org/2000/01/rdf-schema#'))
('rdf', rdflib.URIRef('http://www.w3.org/1999/02/22-rdf-syntax-ns#'))
(u'xsd', rdflib.URIRef('http://www.w3.org/2001/XMLSchema#'))]
"""
if not namespaces:
namespaces = []
for aNamespaceTuple in namespaces:
if aNamespaceTuple[0] and aUriString.find(
aNamespaceTuple[0].__str__() + ":") == 0:
aUriString_name = aUriString.split(":")[1]
return rdflib.term.URIRef(aNamespaceTuple[1] + aUriString_name)
# we dont handle the 'base' URI case
return rdflib.term.URIRef(aUriString) | python | def niceString2uri(aUriString, namespaces=None):
"""
From a string representing a URI possibly with the namespace qname, returns a URI instance.
gold:Citation ==> rdflib.term.URIRef(u'http://purl.org/linguistics/gold/Citation')
Namespaces are a list
[('xml', rdflib.URIRef('http://www.w3.org/XML/1998/namespace'))
('', rdflib.URIRef('http://cohereweb.net/ontology/cohere.owl#'))
(u'owl', rdflib.URIRef('http://www.w3.org/2002/07/owl#'))
('rdfs', rdflib.URIRef('http://www.w3.org/2000/01/rdf-schema#'))
('rdf', rdflib.URIRef('http://www.w3.org/1999/02/22-rdf-syntax-ns#'))
(u'xsd', rdflib.URIRef('http://www.w3.org/2001/XMLSchema#'))]
"""
if not namespaces:
namespaces = []
for aNamespaceTuple in namespaces:
if aNamespaceTuple[0] and aUriString.find(
aNamespaceTuple[0].__str__() + ":") == 0:
aUriString_name = aUriString.split(":")[1]
return rdflib.term.URIRef(aNamespaceTuple[1] + aUriString_name)
# we dont handle the 'base' URI case
return rdflib.term.URIRef(aUriString) | [
"def",
"niceString2uri",
"(",
"aUriString",
",",
"namespaces",
"=",
"None",
")",
":",
"if",
"not",
"namespaces",
":",
"namespaces",
"=",
"[",
"]",
"for",
"aNamespaceTuple",
"in",
"namespaces",
":",
"if",
"aNamespaceTuple",
"[",
"0",
"]",
"and",
"aUriString",
".",
"find",
"(",
"aNamespaceTuple",
"[",
"0",
"]",
".",
"__str__",
"(",
")",
"+",
"\":\"",
")",
"==",
"0",
":",
"aUriString_name",
"=",
"aUriString",
".",
"split",
"(",
"\":\"",
")",
"[",
"1",
"]",
"return",
"rdflib",
".",
"term",
".",
"URIRef",
"(",
"aNamespaceTuple",
"[",
"1",
"]",
"+",
"aUriString_name",
")",
"# we dont handle the 'base' URI case",
"return",
"rdflib",
".",
"term",
".",
"URIRef",
"(",
"aUriString",
")"
] | From a string representing a URI possibly with the namespace qname, returns a URI instance.
gold:Citation ==> rdflib.term.URIRef(u'http://purl.org/linguistics/gold/Citation')
Namespaces are a list
[('xml', rdflib.URIRef('http://www.w3.org/XML/1998/namespace'))
('', rdflib.URIRef('http://cohereweb.net/ontology/cohere.owl#'))
(u'owl', rdflib.URIRef('http://www.w3.org/2002/07/owl#'))
('rdfs', rdflib.URIRef('http://www.w3.org/2000/01/rdf-schema#'))
('rdf', rdflib.URIRef('http://www.w3.org/1999/02/22-rdf-syntax-ns#'))
(u'xsd', rdflib.URIRef('http://www.w3.org/2001/XMLSchema#'))] | [
"From",
"a",
"string",
"representing",
"a",
"URI",
"possibly",
"with",
"the",
"namespace",
"qname",
"returns",
"a",
"URI",
"instance",
"."
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L728-L755 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | shellPrintOverview | def shellPrintOverview(g, opts={'labels': False}):
"""
overview of graph invoked from command line
@todo
add pagination via something like this
# import pydoc
# pydoc.pager("SOME_VERY_LONG_TEXT")
"""
ontologies = g.all_ontologies
# get opts
try:
labels = opts['labels']
except:
labels = False
print(Style.BRIGHT + "Namespaces\n-----------" + Style.RESET_ALL)
if g.namespaces:
for p, u in g.namespaces:
row = Fore.GREEN + "%s" % p + Fore.BLACK + " %s" % u + Fore.RESET
print(row)
else:
printDebug("None found", "comment")
print(Style.BRIGHT + "\nOntologies\n-----------" + Style.RESET_ALL)
if ontologies:
for o in ontologies:
o.printTriples()
else:
printDebug("None found", "comment")
print(Style.BRIGHT + "\nClasses\n" + "-" * 10 + Style.RESET_ALL)
if g.all_classes:
g.printClassTree(showids=False, labels=labels)
else:
printDebug("None found", "comment")
print(Style.BRIGHT + "\nProperties\n" + "-" * 10 + Style.RESET_ALL)
if g.all_properties:
g.printPropertyTree(showids=False, labels=labels)
else:
printDebug("None found", "comment")
print(Style.BRIGHT + "\nSKOS Concepts\n" + "-" * 10 + Style.RESET_ALL)
if g.all_skos_concepts:
g.printSkosTree(showids=False, labels=labels)
else:
printDebug("None found", "comment")
print(Style.BRIGHT + "\nSHACL Shapes\n" + "-" * 10 + Style.RESET_ALL)
if g.all_shapes:
for x in g.all_shapes:
printDebug("%s" % (x.qname))
# printDebug("%s" % (x.bestLabel()), "comment")
else:
printDebug("None found", "comment") | python | def shellPrintOverview(g, opts={'labels': False}):
"""
overview of graph invoked from command line
@todo
add pagination via something like this
# import pydoc
# pydoc.pager("SOME_VERY_LONG_TEXT")
"""
ontologies = g.all_ontologies
# get opts
try:
labels = opts['labels']
except:
labels = False
print(Style.BRIGHT + "Namespaces\n-----------" + Style.RESET_ALL)
if g.namespaces:
for p, u in g.namespaces:
row = Fore.GREEN + "%s" % p + Fore.BLACK + " %s" % u + Fore.RESET
print(row)
else:
printDebug("None found", "comment")
print(Style.BRIGHT + "\nOntologies\n-----------" + Style.RESET_ALL)
if ontologies:
for o in ontologies:
o.printTriples()
else:
printDebug("None found", "comment")
print(Style.BRIGHT + "\nClasses\n" + "-" * 10 + Style.RESET_ALL)
if g.all_classes:
g.printClassTree(showids=False, labels=labels)
else:
printDebug("None found", "comment")
print(Style.BRIGHT + "\nProperties\n" + "-" * 10 + Style.RESET_ALL)
if g.all_properties:
g.printPropertyTree(showids=False, labels=labels)
else:
printDebug("None found", "comment")
print(Style.BRIGHT + "\nSKOS Concepts\n" + "-" * 10 + Style.RESET_ALL)
if g.all_skos_concepts:
g.printSkosTree(showids=False, labels=labels)
else:
printDebug("None found", "comment")
print(Style.BRIGHT + "\nSHACL Shapes\n" + "-" * 10 + Style.RESET_ALL)
if g.all_shapes:
for x in g.all_shapes:
printDebug("%s" % (x.qname))
# printDebug("%s" % (x.bestLabel()), "comment")
else:
printDebug("None found", "comment") | [
"def",
"shellPrintOverview",
"(",
"g",
",",
"opts",
"=",
"{",
"'labels'",
":",
"False",
"}",
")",
":",
"ontologies",
"=",
"g",
".",
"all_ontologies",
"# get opts",
"try",
":",
"labels",
"=",
"opts",
"[",
"'labels'",
"]",
"except",
":",
"labels",
"=",
"False",
"print",
"(",
"Style",
".",
"BRIGHT",
"+",
"\"Namespaces\\n-----------\"",
"+",
"Style",
".",
"RESET_ALL",
")",
"if",
"g",
".",
"namespaces",
":",
"for",
"p",
",",
"u",
"in",
"g",
".",
"namespaces",
":",
"row",
"=",
"Fore",
".",
"GREEN",
"+",
"\"%s\"",
"%",
"p",
"+",
"Fore",
".",
"BLACK",
"+",
"\" %s\"",
"%",
"u",
"+",
"Fore",
".",
"RESET",
"print",
"(",
"row",
")",
"else",
":",
"printDebug",
"(",
"\"None found\"",
",",
"\"comment\"",
")",
"print",
"(",
"Style",
".",
"BRIGHT",
"+",
"\"\\nOntologies\\n-----------\"",
"+",
"Style",
".",
"RESET_ALL",
")",
"if",
"ontologies",
":",
"for",
"o",
"in",
"ontologies",
":",
"o",
".",
"printTriples",
"(",
")",
"else",
":",
"printDebug",
"(",
"\"None found\"",
",",
"\"comment\"",
")",
"print",
"(",
"Style",
".",
"BRIGHT",
"+",
"\"\\nClasses\\n\"",
"+",
"\"-\"",
"*",
"10",
"+",
"Style",
".",
"RESET_ALL",
")",
"if",
"g",
".",
"all_classes",
":",
"g",
".",
"printClassTree",
"(",
"showids",
"=",
"False",
",",
"labels",
"=",
"labels",
")",
"else",
":",
"printDebug",
"(",
"\"None found\"",
",",
"\"comment\"",
")",
"print",
"(",
"Style",
".",
"BRIGHT",
"+",
"\"\\nProperties\\n\"",
"+",
"\"-\"",
"*",
"10",
"+",
"Style",
".",
"RESET_ALL",
")",
"if",
"g",
".",
"all_properties",
":",
"g",
".",
"printPropertyTree",
"(",
"showids",
"=",
"False",
",",
"labels",
"=",
"labels",
")",
"else",
":",
"printDebug",
"(",
"\"None found\"",
",",
"\"comment\"",
")",
"print",
"(",
"Style",
".",
"BRIGHT",
"+",
"\"\\nSKOS Concepts\\n\"",
"+",
"\"-\"",
"*",
"10",
"+",
"Style",
".",
"RESET_ALL",
")",
"if",
"g",
".",
"all_skos_concepts",
":",
"g",
".",
"printSkosTree",
"(",
"showids",
"=",
"False",
",",
"labels",
"=",
"labels",
")",
"else",
":",
"printDebug",
"(",
"\"None found\"",
",",
"\"comment\"",
")",
"print",
"(",
"Style",
".",
"BRIGHT",
"+",
"\"\\nSHACL Shapes\\n\"",
"+",
"\"-\"",
"*",
"10",
"+",
"Style",
".",
"RESET_ALL",
")",
"if",
"g",
".",
"all_shapes",
":",
"for",
"x",
"in",
"g",
".",
"all_shapes",
":",
"printDebug",
"(",
"\"%s\"",
"%",
"(",
"x",
".",
"qname",
")",
")",
"# printDebug(\"%s\" % (x.bestLabel()), \"comment\")",
"else",
":",
"printDebug",
"(",
"\"None found\"",
",",
"\"comment\"",
")"
] | overview of graph invoked from command line
@todo
add pagination via something like this
# import pydoc
# pydoc.pager("SOME_VERY_LONG_TEXT") | [
"overview",
"of",
"graph",
"invoked",
"from",
"command",
"line"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L804-L863 | train |
lambdamusic/Ontospy | ontospy/core/utils.py | try_sort_fmt_opts | def try_sort_fmt_opts(rdf_format_opts_list, uri):
"""reorder fmt options based on uri file type suffix - if available - so to test most likely serialization first when parsing some RDF
NOTE this is not very nice as it is hardcoded and assumes the origin serializations to be this: ['turtle', 'xml', 'n3', 'nt', 'json-ld', 'rdfa']
"""
filename, file_extension = os.path.splitext(uri)
# print(filename, file_extension)
if file_extension == ".ttl" or file_extension == ".turtle":
return ['turtle', 'n3', 'nt', 'json-ld', 'rdfa', 'xml']
elif file_extension == ".xml" or file_extension == ".rdf":
return ['xml', 'turtle', 'n3', 'nt', 'json-ld', 'rdfa']
elif file_extension == ".nt" or file_extension == ".n3":
return ['n3', 'nt', 'turtle', 'xml', 'json-ld', 'rdfa']
elif file_extension == ".json" or file_extension == ".jsonld":
return [
'json-ld',
'rdfa',
'n3',
'nt',
'turtle',
'xml',
]
elif file_extension == ".rdfa":
return [
'rdfa',
'json-ld',
'n3',
'nt',
'turtle',
'xml',
]
else:
return rdf_format_opts_list | python | def try_sort_fmt_opts(rdf_format_opts_list, uri):
"""reorder fmt options based on uri file type suffix - if available - so to test most likely serialization first when parsing some RDF
NOTE this is not very nice as it is hardcoded and assumes the origin serializations to be this: ['turtle', 'xml', 'n3', 'nt', 'json-ld', 'rdfa']
"""
filename, file_extension = os.path.splitext(uri)
# print(filename, file_extension)
if file_extension == ".ttl" or file_extension == ".turtle":
return ['turtle', 'n3', 'nt', 'json-ld', 'rdfa', 'xml']
elif file_extension == ".xml" or file_extension == ".rdf":
return ['xml', 'turtle', 'n3', 'nt', 'json-ld', 'rdfa']
elif file_extension == ".nt" or file_extension == ".n3":
return ['n3', 'nt', 'turtle', 'xml', 'json-ld', 'rdfa']
elif file_extension == ".json" or file_extension == ".jsonld":
return [
'json-ld',
'rdfa',
'n3',
'nt',
'turtle',
'xml',
]
elif file_extension == ".rdfa":
return [
'rdfa',
'json-ld',
'n3',
'nt',
'turtle',
'xml',
]
else:
return rdf_format_opts_list | [
"def",
"try_sort_fmt_opts",
"(",
"rdf_format_opts_list",
",",
"uri",
")",
":",
"filename",
",",
"file_extension",
"=",
"os",
".",
"path",
".",
"splitext",
"(",
"uri",
")",
"# print(filename, file_extension)",
"if",
"file_extension",
"==",
"\".ttl\"",
"or",
"file_extension",
"==",
"\".turtle\"",
":",
"return",
"[",
"'turtle'",
",",
"'n3'",
",",
"'nt'",
",",
"'json-ld'",
",",
"'rdfa'",
",",
"'xml'",
"]",
"elif",
"file_extension",
"==",
"\".xml\"",
"or",
"file_extension",
"==",
"\".rdf\"",
":",
"return",
"[",
"'xml'",
",",
"'turtle'",
",",
"'n3'",
",",
"'nt'",
",",
"'json-ld'",
",",
"'rdfa'",
"]",
"elif",
"file_extension",
"==",
"\".nt\"",
"or",
"file_extension",
"==",
"\".n3\"",
":",
"return",
"[",
"'n3'",
",",
"'nt'",
",",
"'turtle'",
",",
"'xml'",
",",
"'json-ld'",
",",
"'rdfa'",
"]",
"elif",
"file_extension",
"==",
"\".json\"",
"or",
"file_extension",
"==",
"\".jsonld\"",
":",
"return",
"[",
"'json-ld'",
",",
"'rdfa'",
",",
"'n3'",
",",
"'nt'",
",",
"'turtle'",
",",
"'xml'",
",",
"]",
"elif",
"file_extension",
"==",
"\".rdfa\"",
":",
"return",
"[",
"'rdfa'",
",",
"'json-ld'",
",",
"'n3'",
",",
"'nt'",
",",
"'turtle'",
",",
"'xml'",
",",
"]",
"else",
":",
"return",
"rdf_format_opts_list"
] | reorder fmt options based on uri file type suffix - if available - so to test most likely serialization first when parsing some RDF
NOTE this is not very nice as it is hardcoded and assumes the origin serializations to be this: ['turtle', 'xml', 'n3', 'nt', 'json-ld', 'rdfa'] | [
"reorder",
"fmt",
"options",
"based",
"on",
"uri",
"file",
"type",
"suffix",
"-",
"if",
"available",
"-",
"so",
"to",
"test",
"most",
"likely",
"serialization",
"first",
"when",
"parsing",
"some",
"RDF"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/utils.py#L893-L926 | train |
lambdamusic/Ontospy | ontospy/ontodocs/builder.py | ask_visualization | def ask_visualization():
"""
ask user which viz output to use
"""
printDebug(
"Please choose an output format for the ontology visualization: (q=quit)\n",
"important")
while True:
text = ""
for viz in VISUALIZATIONS_LIST:
text += "%d) %s\n" % (VISUALIZATIONS_LIST.index(viz) + 1,
viz['Title'])
var = input(text + ">")
if var == "q":
return ""
else:
try:
n = int(var) - 1
test = VISUALIZATIONS_LIST[
n] # throw exception if number wrong
return n
except:
printDebug("Invalid selection. Please try again.", "red")
continue | python | def ask_visualization():
"""
ask user which viz output to use
"""
printDebug(
"Please choose an output format for the ontology visualization: (q=quit)\n",
"important")
while True:
text = ""
for viz in VISUALIZATIONS_LIST:
text += "%d) %s\n" % (VISUALIZATIONS_LIST.index(viz) + 1,
viz['Title'])
var = input(text + ">")
if var == "q":
return ""
else:
try:
n = int(var) - 1
test = VISUALIZATIONS_LIST[
n] # throw exception if number wrong
return n
except:
printDebug("Invalid selection. Please try again.", "red")
continue | [
"def",
"ask_visualization",
"(",
")",
":",
"printDebug",
"(",
"\"Please choose an output format for the ontology visualization: (q=quit)\\n\"",
",",
"\"important\"",
")",
"while",
"True",
":",
"text",
"=",
"\"\"",
"for",
"viz",
"in",
"VISUALIZATIONS_LIST",
":",
"text",
"+=",
"\"%d) %s\\n\"",
"%",
"(",
"VISUALIZATIONS_LIST",
".",
"index",
"(",
"viz",
")",
"+",
"1",
",",
"viz",
"[",
"'Title'",
"]",
")",
"var",
"=",
"input",
"(",
"text",
"+",
"\">\"",
")",
"if",
"var",
"==",
"\"q\"",
":",
"return",
"\"\"",
"else",
":",
"try",
":",
"n",
"=",
"int",
"(",
"var",
")",
"-",
"1",
"test",
"=",
"VISUALIZATIONS_LIST",
"[",
"n",
"]",
"# throw exception if number wrong",
"return",
"n",
"except",
":",
"printDebug",
"(",
"\"Invalid selection. Please try again.\"",
",",
"\"red\"",
")",
"continue"
] | ask user which viz output to use | [
"ask",
"user",
"which",
"viz",
"output",
"to",
"use"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/ontodocs/builder.py#L111-L134 | train |
lambdamusic/Ontospy | ontospy/ontodocs/builder.py | select_visualization | def select_visualization(n):
"""
get viz choice based on numerical index
"""
try:
n = int(n) - 1
test = VISUALIZATIONS_LIST[n] # throw exception if number wrong
return n
except:
printDebug("Invalid viz-type option. Valid options are:", "red")
show_types()
raise SystemExit(1) | python | def select_visualization(n):
"""
get viz choice based on numerical index
"""
try:
n = int(n) - 1
test = VISUALIZATIONS_LIST[n] # throw exception if number wrong
return n
except:
printDebug("Invalid viz-type option. Valid options are:", "red")
show_types()
raise SystemExit(1) | [
"def",
"select_visualization",
"(",
"n",
")",
":",
"try",
":",
"n",
"=",
"int",
"(",
"n",
")",
"-",
"1",
"test",
"=",
"VISUALIZATIONS_LIST",
"[",
"n",
"]",
"# throw exception if number wrong",
"return",
"n",
"except",
":",
"printDebug",
"(",
"\"Invalid viz-type option. Valid options are:\"",
",",
"\"red\"",
")",
"show_types",
"(",
")",
"raise",
"SystemExit",
"(",
"1",
")"
] | get viz choice based on numerical index | [
"get",
"viz",
"choice",
"based",
"on",
"numerical",
"index"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/ontodocs/builder.py#L137-L148 | train |
lambdamusic/Ontospy | ontospy/core/actions.py | action_analyze | def action_analyze(sources,
endpoint=None,
print_opts=False,
verbose=False,
extra=False,
raw=False):
"""
Load up a model into ontospy and analyze it
"""
for x in sources:
click.secho("Parsing %s..." % str(x), fg='white')
if extra:
hide_base_schemas = False
hide_implicit_types = False
hide_implicit_preds = False
else:
hide_base_schemas = True
hide_implicit_types = True
hide_implicit_preds = True
if raw:
o = Ontospy(uri_or_path=sources, verbose=verbose, build_all=False)
s = o.serialize()
print(s)
return
elif endpoint:
g = Ontospy(
sparql_endpoint=sources[0],
verbose=verbose,
hide_base_schemas=hide_base_schemas,
hide_implicit_types=hide_implicit_types,
hide_implicit_preds=hide_implicit_preds)
printDebug("Extracting classes info")
g.build_classes()
printDebug("..done")
printDebug("Extracting properties info")
g.build_properties()
printDebug("..done")
else:
g = Ontospy(
uri_or_path=sources,
verbose=verbose,
hide_base_schemas=hide_base_schemas,
hide_implicit_types=hide_implicit_types,
hide_implicit_preds=hide_implicit_preds)
shellPrintOverview(g, print_opts) | python | def action_analyze(sources,
endpoint=None,
print_opts=False,
verbose=False,
extra=False,
raw=False):
"""
Load up a model into ontospy and analyze it
"""
for x in sources:
click.secho("Parsing %s..." % str(x), fg='white')
if extra:
hide_base_schemas = False
hide_implicit_types = False
hide_implicit_preds = False
else:
hide_base_schemas = True
hide_implicit_types = True
hide_implicit_preds = True
if raw:
o = Ontospy(uri_or_path=sources, verbose=verbose, build_all=False)
s = o.serialize()
print(s)
return
elif endpoint:
g = Ontospy(
sparql_endpoint=sources[0],
verbose=verbose,
hide_base_schemas=hide_base_schemas,
hide_implicit_types=hide_implicit_types,
hide_implicit_preds=hide_implicit_preds)
printDebug("Extracting classes info")
g.build_classes()
printDebug("..done")
printDebug("Extracting properties info")
g.build_properties()
printDebug("..done")
else:
g = Ontospy(
uri_or_path=sources,
verbose=verbose,
hide_base_schemas=hide_base_schemas,
hide_implicit_types=hide_implicit_types,
hide_implicit_preds=hide_implicit_preds)
shellPrintOverview(g, print_opts) | [
"def",
"action_analyze",
"(",
"sources",
",",
"endpoint",
"=",
"None",
",",
"print_opts",
"=",
"False",
",",
"verbose",
"=",
"False",
",",
"extra",
"=",
"False",
",",
"raw",
"=",
"False",
")",
":",
"for",
"x",
"in",
"sources",
":",
"click",
".",
"secho",
"(",
"\"Parsing %s...\"",
"%",
"str",
"(",
"x",
")",
",",
"fg",
"=",
"'white'",
")",
"if",
"extra",
":",
"hide_base_schemas",
"=",
"False",
"hide_implicit_types",
"=",
"False",
"hide_implicit_preds",
"=",
"False",
"else",
":",
"hide_base_schemas",
"=",
"True",
"hide_implicit_types",
"=",
"True",
"hide_implicit_preds",
"=",
"True",
"if",
"raw",
":",
"o",
"=",
"Ontospy",
"(",
"uri_or_path",
"=",
"sources",
",",
"verbose",
"=",
"verbose",
",",
"build_all",
"=",
"False",
")",
"s",
"=",
"o",
".",
"serialize",
"(",
")",
"print",
"(",
"s",
")",
"return",
"elif",
"endpoint",
":",
"g",
"=",
"Ontospy",
"(",
"sparql_endpoint",
"=",
"sources",
"[",
"0",
"]",
",",
"verbose",
"=",
"verbose",
",",
"hide_base_schemas",
"=",
"hide_base_schemas",
",",
"hide_implicit_types",
"=",
"hide_implicit_types",
",",
"hide_implicit_preds",
"=",
"hide_implicit_preds",
")",
"printDebug",
"(",
"\"Extracting classes info\"",
")",
"g",
".",
"build_classes",
"(",
")",
"printDebug",
"(",
"\"..done\"",
")",
"printDebug",
"(",
"\"Extracting properties info\"",
")",
"g",
".",
"build_properties",
"(",
")",
"printDebug",
"(",
"\"..done\"",
")",
"else",
":",
"g",
"=",
"Ontospy",
"(",
"uri_or_path",
"=",
"sources",
",",
"verbose",
"=",
"verbose",
",",
"hide_base_schemas",
"=",
"hide_base_schemas",
",",
"hide_implicit_types",
"=",
"hide_implicit_types",
",",
"hide_implicit_preds",
"=",
"hide_implicit_preds",
")",
"shellPrintOverview",
"(",
"g",
",",
"print_opts",
")"
] | Load up a model into ontospy and analyze it | [
"Load",
"up",
"a",
"model",
"into",
"ontospy",
"and",
"analyze",
"it"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/actions.py#L64-L111 | train |
lambdamusic/Ontospy | ontospy/core/actions.py | action_listlocal | def action_listlocal(all_details=True):
" select a file from the local repo "
options = get_localontologies()
counter = 1
# printDebug("------------------", 'comment')
if not options:
printDebug(
"Your local library is empty. Use 'ontospy lib --bootstrap' to add some ontologies to it."
)
return
else:
if all_details:
_print_table_ontologies()
else:
_print2cols_ontologies()
while True:
printDebug(
"------------------\nSelect a model by typing its number: (enter=quit)",
"important")
var = input()
if var == "" or var == "q":
return None
else:
try:
_id = int(var)
ontouri = options[_id - 1]
# printDebug("\nYou selected:", "comment")
printDebug(
"---------\nYou selected: " + ontouri + "\n---------",
"green")
return ontouri
except:
printDebug("Please enter a valid option.", "comment")
continue | python | def action_listlocal(all_details=True):
" select a file from the local repo "
options = get_localontologies()
counter = 1
# printDebug("------------------", 'comment')
if not options:
printDebug(
"Your local library is empty. Use 'ontospy lib --bootstrap' to add some ontologies to it."
)
return
else:
if all_details:
_print_table_ontologies()
else:
_print2cols_ontologies()
while True:
printDebug(
"------------------\nSelect a model by typing its number: (enter=quit)",
"important")
var = input()
if var == "" or var == "q":
return None
else:
try:
_id = int(var)
ontouri = options[_id - 1]
# printDebug("\nYou selected:", "comment")
printDebug(
"---------\nYou selected: " + ontouri + "\n---------",
"green")
return ontouri
except:
printDebug("Please enter a valid option.", "comment")
continue | [
"def",
"action_listlocal",
"(",
"all_details",
"=",
"True",
")",
":",
"options",
"=",
"get_localontologies",
"(",
")",
"counter",
"=",
"1",
"# printDebug(\"------------------\", 'comment')\r",
"if",
"not",
"options",
":",
"printDebug",
"(",
"\"Your local library is empty. Use 'ontospy lib --bootstrap' to add some ontologies to it.\"",
")",
"return",
"else",
":",
"if",
"all_details",
":",
"_print_table_ontologies",
"(",
")",
"else",
":",
"_print2cols_ontologies",
"(",
")",
"while",
"True",
":",
"printDebug",
"(",
"\"------------------\\nSelect a model by typing its number: (enter=quit)\"",
",",
"\"important\"",
")",
"var",
"=",
"input",
"(",
")",
"if",
"var",
"==",
"\"\"",
"or",
"var",
"==",
"\"q\"",
":",
"return",
"None",
"else",
":",
"try",
":",
"_id",
"=",
"int",
"(",
"var",
")",
"ontouri",
"=",
"options",
"[",
"_id",
"-",
"1",
"]",
"# printDebug(\"\\nYou selected:\", \"comment\")\r",
"printDebug",
"(",
"\"---------\\nYou selected: \"",
"+",
"ontouri",
"+",
"\"\\n---------\"",
",",
"\"green\"",
")",
"return",
"ontouri",
"except",
":",
"printDebug",
"(",
"\"Please enter a valid option.\"",
",",
"\"comment\"",
")",
"continue"
] | select a file from the local repo | [
"select",
"a",
"file",
"from",
"the",
"local",
"repo"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/actions.py#L156-L192 | train |
lambdamusic/Ontospy | ontospy/core/actions.py | action_import | def action_import(location, verbose=True):
"""
Import files into the local repo
"""
location = str(location) # prevent errors from unicode being passed
# 1) extract file from location and save locally
ONTOSPY_LOCAL_MODELS = get_home_location()
fullpath = ""
try:
if location.startswith("www."): #support for lazy people
location = "http://%s" % str(location)
if location.startswith("http"):
# print("here")
headers = {'Accept': "application/rdf+xml"}
try:
# Py2
req = urllib2.request(location, headers=headers)
res = urllib2.urlopen(req)
except:
# Py3
req = urllib.request.Request(location, headers=headers)
res = urlopen(req)
final_location = res.geturl() # after 303 redirects
printDebug("Saving data from <%s>" % final_location, "green")
# filename = final_location.split("/")[-1] or final_location.split("/")[-2]
filename = location.replace("http://", "").replace("/", "_")
if not filename.lower().endswith(
('.rdf', '.owl', '.rdfs', '.ttl', '.n3')):
filename = filename + ".rdf"
fullpath = ONTOSPY_LOCAL_MODELS + "/" + filename # 2016-04-08
# fullpath = ONTOSPY_LOCAL_MODELS + filename
# print("==DEBUG", final_location, "**", filename,"**", fullpath)
file_ = open(fullpath, 'wb')
file_.write(res.read())
file_.close()
else:
if os.path.isfile(location):
filename = location.split("/")[-1] or location.split("/")[-2]
fullpath = ONTOSPY_LOCAL_MODELS + "/" + filename
shutil.copy(location, fullpath)
else:
raise ValueError('The location specified is not a file.')
# print("Saved local copy")
except:
printDebug(
"Error retrieving file. Please make sure <%s> is a valid location."
% location, "important")
if os.path.exists(fullpath):
os.remove(fullpath)
return None
try:
g = Ontospy(fullpath, verbose=verbose)
# printDebug("----------")
except:
g = None
if os.path.exists(fullpath):
os.remove(fullpath)
printDebug(
"Error parsing file. Please make sure %s contains valid RDF." %
location, "important")
if g:
printDebug("Caching...", "red")
do_pickle_ontology(filename, g)
printDebug("----------\n...completed!", "important")
# finally...
return g | python | def action_import(location, verbose=True):
"""
Import files into the local repo
"""
location = str(location) # prevent errors from unicode being passed
# 1) extract file from location and save locally
ONTOSPY_LOCAL_MODELS = get_home_location()
fullpath = ""
try:
if location.startswith("www."): #support for lazy people
location = "http://%s" % str(location)
if location.startswith("http"):
# print("here")
headers = {'Accept': "application/rdf+xml"}
try:
# Py2
req = urllib2.request(location, headers=headers)
res = urllib2.urlopen(req)
except:
# Py3
req = urllib.request.Request(location, headers=headers)
res = urlopen(req)
final_location = res.geturl() # after 303 redirects
printDebug("Saving data from <%s>" % final_location, "green")
# filename = final_location.split("/")[-1] or final_location.split("/")[-2]
filename = location.replace("http://", "").replace("/", "_")
if not filename.lower().endswith(
('.rdf', '.owl', '.rdfs', '.ttl', '.n3')):
filename = filename + ".rdf"
fullpath = ONTOSPY_LOCAL_MODELS + "/" + filename # 2016-04-08
# fullpath = ONTOSPY_LOCAL_MODELS + filename
# print("==DEBUG", final_location, "**", filename,"**", fullpath)
file_ = open(fullpath, 'wb')
file_.write(res.read())
file_.close()
else:
if os.path.isfile(location):
filename = location.split("/")[-1] or location.split("/")[-2]
fullpath = ONTOSPY_LOCAL_MODELS + "/" + filename
shutil.copy(location, fullpath)
else:
raise ValueError('The location specified is not a file.')
# print("Saved local copy")
except:
printDebug(
"Error retrieving file. Please make sure <%s> is a valid location."
% location, "important")
if os.path.exists(fullpath):
os.remove(fullpath)
return None
try:
g = Ontospy(fullpath, verbose=verbose)
# printDebug("----------")
except:
g = None
if os.path.exists(fullpath):
os.remove(fullpath)
printDebug(
"Error parsing file. Please make sure %s contains valid RDF." %
location, "important")
if g:
printDebug("Caching...", "red")
do_pickle_ontology(filename, g)
printDebug("----------\n...completed!", "important")
# finally...
return g | [
"def",
"action_import",
"(",
"location",
",",
"verbose",
"=",
"True",
")",
":",
"location",
"=",
"str",
"(",
"location",
")",
"# prevent errors from unicode being passed\r",
"# 1) extract file from location and save locally\r",
"ONTOSPY_LOCAL_MODELS",
"=",
"get_home_location",
"(",
")",
"fullpath",
"=",
"\"\"",
"try",
":",
"if",
"location",
".",
"startswith",
"(",
"\"www.\"",
")",
":",
"#support for lazy people\r",
"location",
"=",
"\"http://%s\"",
"%",
"str",
"(",
"location",
")",
"if",
"location",
".",
"startswith",
"(",
"\"http\"",
")",
":",
"# print(\"here\")\r",
"headers",
"=",
"{",
"'Accept'",
":",
"\"application/rdf+xml\"",
"}",
"try",
":",
"# Py2\r",
"req",
"=",
"urllib2",
".",
"request",
"(",
"location",
",",
"headers",
"=",
"headers",
")",
"res",
"=",
"urllib2",
".",
"urlopen",
"(",
"req",
")",
"except",
":",
"# Py3\r",
"req",
"=",
"urllib",
".",
"request",
".",
"Request",
"(",
"location",
",",
"headers",
"=",
"headers",
")",
"res",
"=",
"urlopen",
"(",
"req",
")",
"final_location",
"=",
"res",
".",
"geturl",
"(",
")",
"# after 303 redirects\r",
"printDebug",
"(",
"\"Saving data from <%s>\"",
"%",
"final_location",
",",
"\"green\"",
")",
"# filename = final_location.split(\"/\")[-1] or final_location.split(\"/\")[-2]\r",
"filename",
"=",
"location",
".",
"replace",
"(",
"\"http://\"",
",",
"\"\"",
")",
".",
"replace",
"(",
"\"/\"",
",",
"\"_\"",
")",
"if",
"not",
"filename",
".",
"lower",
"(",
")",
".",
"endswith",
"(",
"(",
"'.rdf'",
",",
"'.owl'",
",",
"'.rdfs'",
",",
"'.ttl'",
",",
"'.n3'",
")",
")",
":",
"filename",
"=",
"filename",
"+",
"\".rdf\"",
"fullpath",
"=",
"ONTOSPY_LOCAL_MODELS",
"+",
"\"/\"",
"+",
"filename",
"# 2016-04-08\r",
"# fullpath = ONTOSPY_LOCAL_MODELS + filename\r",
"# print(\"==DEBUG\", final_location, \"**\", filename,\"**\", fullpath)\r",
"file_",
"=",
"open",
"(",
"fullpath",
",",
"'wb'",
")",
"file_",
".",
"write",
"(",
"res",
".",
"read",
"(",
")",
")",
"file_",
".",
"close",
"(",
")",
"else",
":",
"if",
"os",
".",
"path",
".",
"isfile",
"(",
"location",
")",
":",
"filename",
"=",
"location",
".",
"split",
"(",
"\"/\"",
")",
"[",
"-",
"1",
"]",
"or",
"location",
".",
"split",
"(",
"\"/\"",
")",
"[",
"-",
"2",
"]",
"fullpath",
"=",
"ONTOSPY_LOCAL_MODELS",
"+",
"\"/\"",
"+",
"filename",
"shutil",
".",
"copy",
"(",
"location",
",",
"fullpath",
")",
"else",
":",
"raise",
"ValueError",
"(",
"'The location specified is not a file.'",
")",
"# print(\"Saved local copy\")\r",
"except",
":",
"printDebug",
"(",
"\"Error retrieving file. Please make sure <%s> is a valid location.\"",
"%",
"location",
",",
"\"important\"",
")",
"if",
"os",
".",
"path",
".",
"exists",
"(",
"fullpath",
")",
":",
"os",
".",
"remove",
"(",
"fullpath",
")",
"return",
"None",
"try",
":",
"g",
"=",
"Ontospy",
"(",
"fullpath",
",",
"verbose",
"=",
"verbose",
")",
"# printDebug(\"----------\")\r",
"except",
":",
"g",
"=",
"None",
"if",
"os",
".",
"path",
".",
"exists",
"(",
"fullpath",
")",
":",
"os",
".",
"remove",
"(",
"fullpath",
")",
"printDebug",
"(",
"\"Error parsing file. Please make sure %s contains valid RDF.\"",
"%",
"location",
",",
"\"important\"",
")",
"if",
"g",
":",
"printDebug",
"(",
"\"Caching...\"",
",",
"\"red\"",
")",
"do_pickle_ontology",
"(",
"filename",
",",
"g",
")",
"printDebug",
"(",
"\"----------\\n...completed!\"",
",",
"\"important\"",
")",
"# finally...\r",
"return",
"g"
] | Import files into the local repo | [
"Import",
"files",
"into",
"the",
"local",
"repo"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/actions.py#L243-L316 | train |
lambdamusic/Ontospy | ontospy/core/actions.py | action_import_folder | def action_import_folder(location):
"""Try to import all files from a local folder"""
if os.path.isdir(location):
onlyfiles = [
f for f in os.listdir(location)
if os.path.isfile(os.path.join(location, f))
]
for file in onlyfiles:
if not file.startswith("."):
filepath = os.path.join(location, file)
# print(Fore.RED + "\n---------\n" + filepath + "\n---------" + Style.RESET_ALL)
click.secho(
"\n---------\n" + filepath + "\n---------", fg='red')
return action_import(filepath)
else:
printDebug("Not a valid directory", "important")
return None | python | def action_import_folder(location):
"""Try to import all files from a local folder"""
if os.path.isdir(location):
onlyfiles = [
f for f in os.listdir(location)
if os.path.isfile(os.path.join(location, f))
]
for file in onlyfiles:
if not file.startswith("."):
filepath = os.path.join(location, file)
# print(Fore.RED + "\n---------\n" + filepath + "\n---------" + Style.RESET_ALL)
click.secho(
"\n---------\n" + filepath + "\n---------", fg='red')
return action_import(filepath)
else:
printDebug("Not a valid directory", "important")
return None | [
"def",
"action_import_folder",
"(",
"location",
")",
":",
"if",
"os",
".",
"path",
".",
"isdir",
"(",
"location",
")",
":",
"onlyfiles",
"=",
"[",
"f",
"for",
"f",
"in",
"os",
".",
"listdir",
"(",
"location",
")",
"if",
"os",
".",
"path",
".",
"isfile",
"(",
"os",
".",
"path",
".",
"join",
"(",
"location",
",",
"f",
")",
")",
"]",
"for",
"file",
"in",
"onlyfiles",
":",
"if",
"not",
"file",
".",
"startswith",
"(",
"\".\"",
")",
":",
"filepath",
"=",
"os",
".",
"path",
".",
"join",
"(",
"location",
",",
"file",
")",
"# print(Fore.RED + \"\\n---------\\n\" + filepath + \"\\n---------\" + Style.RESET_ALL)\r",
"click",
".",
"secho",
"(",
"\"\\n---------\\n\"",
"+",
"filepath",
"+",
"\"\\n---------\"",
",",
"fg",
"=",
"'red'",
")",
"return",
"action_import",
"(",
"filepath",
")",
"else",
":",
"printDebug",
"(",
"\"Not a valid directory\"",
",",
"\"important\"",
")",
"return",
"None"
] | Try to import all files from a local folder | [
"Try",
"to",
"import",
"all",
"files",
"from",
"a",
"local",
"folder"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/actions.py#L319-L336 | train |
lambdamusic/Ontospy | ontospy/core/actions.py | action_webimport | def action_webimport(hrlinetop=False):
""" select from the available online directories for import """
DIR_OPTIONS = {1: "http://lov.okfn.org", 2: "http://prefix.cc/popular/"}
selection = None
while True:
if hrlinetop:
printDebug("----------")
text = "Please select which online directory to scan: (enter=quit)\n"
for x in DIR_OPTIONS:
text += "%d) %s\n" % (x, DIR_OPTIONS[x])
var = input(text + "> ")
if var == "q" or var == "":
return None
else:
try:
selection = int(var)
test = DIR_OPTIONS[selection] #throw exception if number wrong
break
except:
printDebug("Invalid selection. Please try again.", "important")
continue
printDebug("----------")
text = "Search for a specific keyword? (enter=show all)\n"
var = input(text + "> ")
keyword = var
try:
if selection == 1:
_import_LOV(keyword=keyword)
elif selection == 2:
_import_PREFIXCC(keyword=keyword)
except:
printDebug("Sorry, the online repository seems to be unreachable.")
return True | python | def action_webimport(hrlinetop=False):
""" select from the available online directories for import """
DIR_OPTIONS = {1: "http://lov.okfn.org", 2: "http://prefix.cc/popular/"}
selection = None
while True:
if hrlinetop:
printDebug("----------")
text = "Please select which online directory to scan: (enter=quit)\n"
for x in DIR_OPTIONS:
text += "%d) %s\n" % (x, DIR_OPTIONS[x])
var = input(text + "> ")
if var == "q" or var == "":
return None
else:
try:
selection = int(var)
test = DIR_OPTIONS[selection] #throw exception if number wrong
break
except:
printDebug("Invalid selection. Please try again.", "important")
continue
printDebug("----------")
text = "Search for a specific keyword? (enter=show all)\n"
var = input(text + "> ")
keyword = var
try:
if selection == 1:
_import_LOV(keyword=keyword)
elif selection == 2:
_import_PREFIXCC(keyword=keyword)
except:
printDebug("Sorry, the online repository seems to be unreachable.")
return True | [
"def",
"action_webimport",
"(",
"hrlinetop",
"=",
"False",
")",
":",
"DIR_OPTIONS",
"=",
"{",
"1",
":",
"\"http://lov.okfn.org\"",
",",
"2",
":",
"\"http://prefix.cc/popular/\"",
"}",
"selection",
"=",
"None",
"while",
"True",
":",
"if",
"hrlinetop",
":",
"printDebug",
"(",
"\"----------\"",
")",
"text",
"=",
"\"Please select which online directory to scan: (enter=quit)\\n\"",
"for",
"x",
"in",
"DIR_OPTIONS",
":",
"text",
"+=",
"\"%d) %s\\n\"",
"%",
"(",
"x",
",",
"DIR_OPTIONS",
"[",
"x",
"]",
")",
"var",
"=",
"input",
"(",
"text",
"+",
"\"> \"",
")",
"if",
"var",
"==",
"\"q\"",
"or",
"var",
"==",
"\"\"",
":",
"return",
"None",
"else",
":",
"try",
":",
"selection",
"=",
"int",
"(",
"var",
")",
"test",
"=",
"DIR_OPTIONS",
"[",
"selection",
"]",
"#throw exception if number wrong\r",
"break",
"except",
":",
"printDebug",
"(",
"\"Invalid selection. Please try again.\"",
",",
"\"important\"",
")",
"continue",
"printDebug",
"(",
"\"----------\"",
")",
"text",
"=",
"\"Search for a specific keyword? (enter=show all)\\n\"",
"var",
"=",
"input",
"(",
"text",
"+",
"\"> \"",
")",
"keyword",
"=",
"var",
"try",
":",
"if",
"selection",
"==",
"1",
":",
"_import_LOV",
"(",
"keyword",
"=",
"keyword",
")",
"elif",
"selection",
"==",
"2",
":",
"_import_PREFIXCC",
"(",
"keyword",
"=",
"keyword",
")",
"except",
":",
"printDebug",
"(",
"\"Sorry, the online repository seems to be unreachable.\"",
")",
"return",
"True"
] | select from the available online directories for import | [
"select",
"from",
"the",
"available",
"online",
"directories",
"for",
"import"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/actions.py#L339-L374 | train |
lambdamusic/Ontospy | ontospy/core/actions.py | action_bootstrap | def action_bootstrap(verbose=False):
"""Bootstrap the local REPO with a few cool ontologies"""
printDebug("The following ontologies will be imported:")
printDebug("--------------")
count = 0
for s in BOOTSTRAP_ONTOLOGIES:
count += 1
print(count, "<%s>" % s)
printDebug("--------------")
printDebug("Note: this operation may take several minutes.")
printDebug("Proceed? [Y/N]")
var = input()
if var == "y" or var == "Y":
for uri in BOOTSTRAP_ONTOLOGIES:
try:
printDebug("--------------")
action_import(uri, verbose)
except:
printDebug(
"OPS... An Unknown Error Occurred - Aborting Installation")
printDebug("\n==========\n" + "Bootstrap command completed.",
"important")
return True
else:
printDebug("--------------")
printDebug("Goodbye")
return False | python | def action_bootstrap(verbose=False):
"""Bootstrap the local REPO with a few cool ontologies"""
printDebug("The following ontologies will be imported:")
printDebug("--------------")
count = 0
for s in BOOTSTRAP_ONTOLOGIES:
count += 1
print(count, "<%s>" % s)
printDebug("--------------")
printDebug("Note: this operation may take several minutes.")
printDebug("Proceed? [Y/N]")
var = input()
if var == "y" or var == "Y":
for uri in BOOTSTRAP_ONTOLOGIES:
try:
printDebug("--------------")
action_import(uri, verbose)
except:
printDebug(
"OPS... An Unknown Error Occurred - Aborting Installation")
printDebug("\n==========\n" + "Bootstrap command completed.",
"important")
return True
else:
printDebug("--------------")
printDebug("Goodbye")
return False | [
"def",
"action_bootstrap",
"(",
"verbose",
"=",
"False",
")",
":",
"printDebug",
"(",
"\"The following ontologies will be imported:\"",
")",
"printDebug",
"(",
"\"--------------\"",
")",
"count",
"=",
"0",
"for",
"s",
"in",
"BOOTSTRAP_ONTOLOGIES",
":",
"count",
"+=",
"1",
"print",
"(",
"count",
",",
"\"<%s>\"",
"%",
"s",
")",
"printDebug",
"(",
"\"--------------\"",
")",
"printDebug",
"(",
"\"Note: this operation may take several minutes.\"",
")",
"printDebug",
"(",
"\"Proceed? [Y/N]\"",
")",
"var",
"=",
"input",
"(",
")",
"if",
"var",
"==",
"\"y\"",
"or",
"var",
"==",
"\"Y\"",
":",
"for",
"uri",
"in",
"BOOTSTRAP_ONTOLOGIES",
":",
"try",
":",
"printDebug",
"(",
"\"--------------\"",
")",
"action_import",
"(",
"uri",
",",
"verbose",
")",
"except",
":",
"printDebug",
"(",
"\"OPS... An Unknown Error Occurred - Aborting Installation\"",
")",
"printDebug",
"(",
"\"\\n==========\\n\"",
"+",
"\"Bootstrap command completed.\"",
",",
"\"important\"",
")",
"return",
"True",
"else",
":",
"printDebug",
"(",
"\"--------------\"",
")",
"printDebug",
"(",
"\"Goodbye\"",
")",
"return",
"False"
] | Bootstrap the local REPO with a few cool ontologies | [
"Bootstrap",
"the",
"local",
"REPO",
"with",
"a",
"few",
"cool",
"ontologies"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/actions.py#L487-L514 | train |
lambdamusic/Ontospy | ontospy/core/actions.py | action_update_library_location | def action_update_library_location(_location):
"""
Sets the folder that contains models for the local library
@todo: add options to move things over etc..
note: this is called from 'manager'
"""
# if not(os.path.exists(_location)):
# os.mkdir(_location)
# printDebug("Creating new folder..", "comment")
printDebug("Old location: '%s'" % get_home_location(), "comment")
if os.path.isdir(_location):
config = SafeConfigParser()
config_filename = ONTOSPY_LOCAL + '/config.ini'
config.read(config_filename)
if not config.has_section('models'):
config.add_section('models')
config.set('models', 'dir', _location)
with open(config_filename, 'w') as f:
config.write(
f) # note: this does not remove previously saved settings
return _location
else:
return None | python | def action_update_library_location(_location):
"""
Sets the folder that contains models for the local library
@todo: add options to move things over etc..
note: this is called from 'manager'
"""
# if not(os.path.exists(_location)):
# os.mkdir(_location)
# printDebug("Creating new folder..", "comment")
printDebug("Old location: '%s'" % get_home_location(), "comment")
if os.path.isdir(_location):
config = SafeConfigParser()
config_filename = ONTOSPY_LOCAL + '/config.ini'
config.read(config_filename)
if not config.has_section('models'):
config.add_section('models')
config.set('models', 'dir', _location)
with open(config_filename, 'w') as f:
config.write(
f) # note: this does not remove previously saved settings
return _location
else:
return None | [
"def",
"action_update_library_location",
"(",
"_location",
")",
":",
"# if not(os.path.exists(_location)):\r",
"# \tos.mkdir(_location)\r",
"# \tprintDebug(\"Creating new folder..\", \"comment\")\r",
"printDebug",
"(",
"\"Old location: '%s'\"",
"%",
"get_home_location",
"(",
")",
",",
"\"comment\"",
")",
"if",
"os",
".",
"path",
".",
"isdir",
"(",
"_location",
")",
":",
"config",
"=",
"SafeConfigParser",
"(",
")",
"config_filename",
"=",
"ONTOSPY_LOCAL",
"+",
"'/config.ini'",
"config",
".",
"read",
"(",
"config_filename",
")",
"if",
"not",
"config",
".",
"has_section",
"(",
"'models'",
")",
":",
"config",
".",
"add_section",
"(",
"'models'",
")",
"config",
".",
"set",
"(",
"'models'",
",",
"'dir'",
",",
"_location",
")",
"with",
"open",
"(",
"config_filename",
",",
"'w'",
")",
"as",
"f",
":",
"config",
".",
"write",
"(",
"f",
")",
"# note: this does not remove previously saved settings\r",
"return",
"_location",
"else",
":",
"return",
"None"
] | Sets the folder that contains models for the local library
@todo: add options to move things over etc..
note: this is called from 'manager' | [
"Sets",
"the",
"folder",
"that",
"contains",
"models",
"for",
"the",
"local",
"library"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/actions.py#L517-L545 | train |
lambdamusic/Ontospy | ontospy/core/actions.py | action_cache_reset | def action_cache_reset():
"""
Delete all contents from cache folder
Then re-generate cached version of all models in the local repo
"""
printDebug("""The existing cache will be erased and recreated.""")
printDebug(
"""This operation may take several minutes, depending on how many files exist in your local library."""
)
ONTOSPY_LOCAL_MODELS = get_home_location()
# https://stackoverflow.com/questions/185936/how-to-delete-the-contents-of-a-folder-in-python
# NOTE This will not only delete the contents but the folder itself as well.
shutil.rmtree(ONTOSPY_LOCAL_CACHE_TOP)
var = input(Style.BRIGHT + "=====\nProceed? (y/n) " + Style.RESET_ALL)
if var == "y":
repo_contents = get_localontologies()
print(Style.BRIGHT +
"\n=====\n%d ontologies available in the local library\n=====" %
len(repo_contents) + Style.RESET_ALL)
for onto in repo_contents:
fullpath = ONTOSPY_LOCAL_MODELS + "/" + onto
try:
print(Fore.RED + "\n=====\n" + onto + Style.RESET_ALL)
print("Loading graph...")
g = Ontospy(fullpath)
print("Loaded ", fullpath)
except:
g = None
print(
"Error parsing file. Please make sure %s contains valid RDF."
% fullpath)
if g:
print("Caching...")
do_pickle_ontology(onto, g)
print(Style.BRIGHT + "===Completed===" + Style.RESET_ALL)
else:
print("Goodbye") | python | def action_cache_reset():
"""
Delete all contents from cache folder
Then re-generate cached version of all models in the local repo
"""
printDebug("""The existing cache will be erased and recreated.""")
printDebug(
"""This operation may take several minutes, depending on how many files exist in your local library."""
)
ONTOSPY_LOCAL_MODELS = get_home_location()
# https://stackoverflow.com/questions/185936/how-to-delete-the-contents-of-a-folder-in-python
# NOTE This will not only delete the contents but the folder itself as well.
shutil.rmtree(ONTOSPY_LOCAL_CACHE_TOP)
var = input(Style.BRIGHT + "=====\nProceed? (y/n) " + Style.RESET_ALL)
if var == "y":
repo_contents = get_localontologies()
print(Style.BRIGHT +
"\n=====\n%d ontologies available in the local library\n=====" %
len(repo_contents) + Style.RESET_ALL)
for onto in repo_contents:
fullpath = ONTOSPY_LOCAL_MODELS + "/" + onto
try:
print(Fore.RED + "\n=====\n" + onto + Style.RESET_ALL)
print("Loading graph...")
g = Ontospy(fullpath)
print("Loaded ", fullpath)
except:
g = None
print(
"Error parsing file. Please make sure %s contains valid RDF."
% fullpath)
if g:
print("Caching...")
do_pickle_ontology(onto, g)
print(Style.BRIGHT + "===Completed===" + Style.RESET_ALL)
else:
print("Goodbye") | [
"def",
"action_cache_reset",
"(",
")",
":",
"printDebug",
"(",
"\"\"\"The existing cache will be erased and recreated.\"\"\"",
")",
"printDebug",
"(",
"\"\"\"This operation may take several minutes, depending on how many files exist in your local library.\"\"\"",
")",
"ONTOSPY_LOCAL_MODELS",
"=",
"get_home_location",
"(",
")",
"# https://stackoverflow.com/questions/185936/how-to-delete-the-contents-of-a-folder-in-python\r",
"# NOTE This will not only delete the contents but the folder itself as well.\r",
"shutil",
".",
"rmtree",
"(",
"ONTOSPY_LOCAL_CACHE_TOP",
")",
"var",
"=",
"input",
"(",
"Style",
".",
"BRIGHT",
"+",
"\"=====\\nProceed? (y/n) \"",
"+",
"Style",
".",
"RESET_ALL",
")",
"if",
"var",
"==",
"\"y\"",
":",
"repo_contents",
"=",
"get_localontologies",
"(",
")",
"print",
"(",
"Style",
".",
"BRIGHT",
"+",
"\"\\n=====\\n%d ontologies available in the local library\\n=====\"",
"%",
"len",
"(",
"repo_contents",
")",
"+",
"Style",
".",
"RESET_ALL",
")",
"for",
"onto",
"in",
"repo_contents",
":",
"fullpath",
"=",
"ONTOSPY_LOCAL_MODELS",
"+",
"\"/\"",
"+",
"onto",
"try",
":",
"print",
"(",
"Fore",
".",
"RED",
"+",
"\"\\n=====\\n\"",
"+",
"onto",
"+",
"Style",
".",
"RESET_ALL",
")",
"print",
"(",
"\"Loading graph...\"",
")",
"g",
"=",
"Ontospy",
"(",
"fullpath",
")",
"print",
"(",
"\"Loaded \"",
",",
"fullpath",
")",
"except",
":",
"g",
"=",
"None",
"print",
"(",
"\"Error parsing file. Please make sure %s contains valid RDF.\"",
"%",
"fullpath",
")",
"if",
"g",
":",
"print",
"(",
"\"Caching...\"",
")",
"do_pickle_ontology",
"(",
"onto",
",",
"g",
")",
"print",
"(",
"Style",
".",
"BRIGHT",
"+",
"\"===Completed===\"",
"+",
"Style",
".",
"RESET_ALL",
")",
"else",
":",
"print",
"(",
"\"Goodbye\"",
")"
] | Delete all contents from cache folder
Then re-generate cached version of all models in the local repo | [
"Delete",
"all",
"contents",
"from",
"cache",
"folder",
"Then",
"re",
"-",
"generate",
"cached",
"version",
"of",
"all",
"models",
"in",
"the",
"local",
"repo"
] | eb46cb13792b2b87f21babdf976996318eec7571 | https://github.com/lambdamusic/Ontospy/blob/eb46cb13792b2b87f21babdf976996318eec7571/ontospy/core/actions.py#L548-L589 | train |
gabrielfalcao/sure | sure/core.py | DeepComparison.compare_ordereddict | def compare_ordereddict(self, X, Y):
"""Compares two instances of an OrderedDict."""
# check if OrderedDict instances have the same keys and values
child = self.compare_dicts(X, Y)
if isinstance(child, DeepExplanation):
return child
# check if the order of the keys is the same
for i, j in zip(X.items(), Y.items()):
if i[0] != j[0]:
c = self.get_context()
msg = "X{0} and Y{1} are in a different order".format(
red(c.current_X_keys), green(c.current_Y_keys)
)
return DeepExplanation(msg)
return True | python | def compare_ordereddict(self, X, Y):
"""Compares two instances of an OrderedDict."""
# check if OrderedDict instances have the same keys and values
child = self.compare_dicts(X, Y)
if isinstance(child, DeepExplanation):
return child
# check if the order of the keys is the same
for i, j in zip(X.items(), Y.items()):
if i[0] != j[0]:
c = self.get_context()
msg = "X{0} and Y{1} are in a different order".format(
red(c.current_X_keys), green(c.current_Y_keys)
)
return DeepExplanation(msg)
return True | [
"def",
"compare_ordereddict",
"(",
"self",
",",
"X",
",",
"Y",
")",
":",
"# check if OrderedDict instances have the same keys and values",
"child",
"=",
"self",
".",
"compare_dicts",
"(",
"X",
",",
"Y",
")",
"if",
"isinstance",
"(",
"child",
",",
"DeepExplanation",
")",
":",
"return",
"child",
"# check if the order of the keys is the same",
"for",
"i",
",",
"j",
"in",
"zip",
"(",
"X",
".",
"items",
"(",
")",
",",
"Y",
".",
"items",
"(",
")",
")",
":",
"if",
"i",
"[",
"0",
"]",
"!=",
"j",
"[",
"0",
"]",
":",
"c",
"=",
"self",
".",
"get_context",
"(",
")",
"msg",
"=",
"\"X{0} and Y{1} are in a different order\"",
".",
"format",
"(",
"red",
"(",
"c",
".",
"current_X_keys",
")",
",",
"green",
"(",
"c",
".",
"current_Y_keys",
")",
")",
"return",
"DeepExplanation",
"(",
"msg",
")",
"return",
"True"
] | Compares two instances of an OrderedDict. | [
"Compares",
"two",
"instances",
"of",
"an",
"OrderedDict",
"."
] | ac23b6b87306ec502b8719534ab23965d97a95f9 | https://github.com/gabrielfalcao/sure/blob/ac23b6b87306ec502b8719534ab23965d97a95f9/sure/core.py#L146-L162 | train |
gabrielfalcao/sure | sure/stubs.py | stub | def stub(base_class=None, **attributes):
"""creates a python class on-the-fly with the given keyword-arguments
as class-attributes accessible with .attrname.
The new class inherits from
Use this to mock rather than stub.
"""
if base_class is None:
base_class = object
members = {
"__init__": lambda self: None,
"__new__": lambda *args, **kw: object.__new__(
*args, *kw
), # remove __new__ and metaclass behavior from object
"__metaclass__": None,
}
members.update(attributes)
# let's create a python class on-the-fly :)
return type(f"{base_class.__name__}Stub", (base_class,), members)() | python | def stub(base_class=None, **attributes):
"""creates a python class on-the-fly with the given keyword-arguments
as class-attributes accessible with .attrname.
The new class inherits from
Use this to mock rather than stub.
"""
if base_class is None:
base_class = object
members = {
"__init__": lambda self: None,
"__new__": lambda *args, **kw: object.__new__(
*args, *kw
), # remove __new__ and metaclass behavior from object
"__metaclass__": None,
}
members.update(attributes)
# let's create a python class on-the-fly :)
return type(f"{base_class.__name__}Stub", (base_class,), members)() | [
"def",
"stub",
"(",
"base_class",
"=",
"None",
",",
"*",
"*",
"attributes",
")",
":",
"if",
"base_class",
"is",
"None",
":",
"base_class",
"=",
"object",
"members",
"=",
"{",
"\"__init__\"",
":",
"lambda",
"self",
":",
"None",
",",
"\"__new__\"",
":",
"lambda",
"*",
"args",
",",
"*",
"*",
"kw",
":",
"object",
".",
"__new__",
"(",
"*",
"args",
",",
"*",
"kw",
")",
",",
"# remove __new__ and metaclass behavior from object",
"\"__metaclass__\"",
":",
"None",
",",
"}",
"members",
".",
"update",
"(",
"attributes",
")",
"# let's create a python class on-the-fly :)",
"return",
"type",
"(",
"f\"{base_class.__name__}Stub\"",
",",
"(",
"base_class",
",",
")",
",",
"members",
")",
"(",
")"
] | creates a python class on-the-fly with the given keyword-arguments
as class-attributes accessible with .attrname.
The new class inherits from
Use this to mock rather than stub. | [
"creates",
"a",
"python",
"class",
"on",
"-",
"the",
"-",
"fly",
"with",
"the",
"given",
"keyword",
"-",
"arguments",
"as",
"class",
"-",
"attributes",
"accessible",
"with",
".",
"attrname",
"."
] | ac23b6b87306ec502b8719534ab23965d97a95f9 | https://github.com/gabrielfalcao/sure/blob/ac23b6b87306ec502b8719534ab23965d97a95f9/sure/stubs.py#L19-L38 | train |
gabrielfalcao/sure | sure/__init__.py | assertion | def assertion(func):
"""Extend sure with a custom assertion method."""
func = assertionmethod(func)
setattr(AssertionBuilder, func.__name__, func)
return func | python | def assertion(func):
"""Extend sure with a custom assertion method."""
func = assertionmethod(func)
setattr(AssertionBuilder, func.__name__, func)
return func | [
"def",
"assertion",
"(",
"func",
")",
":",
"func",
"=",
"assertionmethod",
"(",
"func",
")",
"setattr",
"(",
"AssertionBuilder",
",",
"func",
".",
"__name__",
",",
"func",
")",
"return",
"func"
] | Extend sure with a custom assertion method. | [
"Extend",
"sure",
"with",
"a",
"custom",
"assertion",
"method",
"."
] | ac23b6b87306ec502b8719534ab23965d97a95f9 | https://github.com/gabrielfalcao/sure/blob/ac23b6b87306ec502b8719534ab23965d97a95f9/sure/__init__.py#L928-L932 | train |
gabrielfalcao/sure | sure/__init__.py | chainproperty | def chainproperty(func):
"""Extend sure with a custom chain property."""
func = assertionproperty(func)
setattr(AssertionBuilder, func.fget.__name__, func)
return func | python | def chainproperty(func):
"""Extend sure with a custom chain property."""
func = assertionproperty(func)
setattr(AssertionBuilder, func.fget.__name__, func)
return func | [
"def",
"chainproperty",
"(",
"func",
")",
":",
"func",
"=",
"assertionproperty",
"(",
"func",
")",
"setattr",
"(",
"AssertionBuilder",
",",
"func",
".",
"fget",
".",
"__name__",
",",
"func",
")",
"return",
"func"
] | Extend sure with a custom chain property. | [
"Extend",
"sure",
"with",
"a",
"custom",
"chain",
"property",
"."
] | ac23b6b87306ec502b8719534ab23965d97a95f9 | https://github.com/gabrielfalcao/sure/blob/ac23b6b87306ec502b8719534ab23965d97a95f9/sure/__init__.py#L941-L945 | train |
gabrielfalcao/sure | sure/__init__.py | AssertionBuilder.equal | def equal(self, what, epsilon=None):
"""compares given object ``X`` with an expected ``Y`` object.
It primarily assures that the compared objects are absolute equal ``==``.
:param what: the expected value
:param epsilon: a delta to leverage upper-bound floating point permissiveness
"""
try:
comparison = DeepComparison(self.obj, what, epsilon).compare()
error = False
except AssertionError as e:
error = e
comparison = None
if isinstance(comparison, DeepExplanation):
error = comparison.get_assertion(self.obj, what)
if self.negative:
if error:
return True
msg = '%s should differ from %s, but is the same thing'
raise AssertionError(msg % (safe_repr(self.obj), safe_repr(what)))
else:
if not error:
return True
raise error | python | def equal(self, what, epsilon=None):
"""compares given object ``X`` with an expected ``Y`` object.
It primarily assures that the compared objects are absolute equal ``==``.
:param what: the expected value
:param epsilon: a delta to leverage upper-bound floating point permissiveness
"""
try:
comparison = DeepComparison(self.obj, what, epsilon).compare()
error = False
except AssertionError as e:
error = e
comparison = None
if isinstance(comparison, DeepExplanation):
error = comparison.get_assertion(self.obj, what)
if self.negative:
if error:
return True
msg = '%s should differ from %s, but is the same thing'
raise AssertionError(msg % (safe_repr(self.obj), safe_repr(what)))
else:
if not error:
return True
raise error | [
"def",
"equal",
"(",
"self",
",",
"what",
",",
"epsilon",
"=",
"None",
")",
":",
"try",
":",
"comparison",
"=",
"DeepComparison",
"(",
"self",
".",
"obj",
",",
"what",
",",
"epsilon",
")",
".",
"compare",
"(",
")",
"error",
"=",
"False",
"except",
"AssertionError",
"as",
"e",
":",
"error",
"=",
"e",
"comparison",
"=",
"None",
"if",
"isinstance",
"(",
"comparison",
",",
"DeepExplanation",
")",
":",
"error",
"=",
"comparison",
".",
"get_assertion",
"(",
"self",
".",
"obj",
",",
"what",
")",
"if",
"self",
".",
"negative",
":",
"if",
"error",
":",
"return",
"True",
"msg",
"=",
"'%s should differ from %s, but is the same thing'",
"raise",
"AssertionError",
"(",
"msg",
"%",
"(",
"safe_repr",
"(",
"self",
".",
"obj",
")",
",",
"safe_repr",
"(",
"what",
")",
")",
")",
"else",
":",
"if",
"not",
"error",
":",
"return",
"True",
"raise",
"error"
] | compares given object ``X`` with an expected ``Y`` object.
It primarily assures that the compared objects are absolute equal ``==``.
:param what: the expected value
:param epsilon: a delta to leverage upper-bound floating point permissiveness | [
"compares",
"given",
"object",
"X",
"with",
"an",
"expected",
"Y",
"object",
"."
] | ac23b6b87306ec502b8719534ab23965d97a95f9 | https://github.com/gabrielfalcao/sure/blob/ac23b6b87306ec502b8719534ab23965d97a95f9/sure/__init__.py#L644-L673 | train |
aspiers/git-deps | git_deps/detector.py | DependencyDetector.find_dependencies | def find_dependencies(self, dependent_rev, recurse=None):
"""Find all dependencies of the given revision, recursively traversing
the dependency tree if requested.
"""
if recurse is None:
recurse = self.options.recurse
try:
dependent = self.get_commit(dependent_rev)
except InvalidCommitish as e:
abort(e.message())
self.todo.append(dependent)
self.todo_d[dependent.hex] = True
first_time = True
while self.todo:
sha1s = [commit.hex[:8] for commit in self.todo]
if first_time:
self.logger.info("Initial TODO list: %s" % " ".join(sha1s))
first_time = False
else:
self.logger.info(" TODO list now: %s" % " ".join(sha1s))
dependent = self.todo.pop(0)
dependent_sha1 = dependent.hex
del self.todo_d[dependent_sha1]
self.logger.info(" Processing %s from TODO list" %
dependent_sha1[:8])
if dependent_sha1 in self.done_d:
self.logger.info(" %s already done previously" %
dependent_sha1)
continue
self.notify_listeners('new_commit', dependent)
parent = dependent.parents[0]
self.find_dependencies_with_parent(dependent, parent)
self.done.append(dependent_sha1)
self.done_d[dependent_sha1] = True
self.logger.info(" Found all dependencies for %s" %
dependent_sha1[:8])
# A commit won't have any dependencies if it only added new files
dependencies = self.dependencies.get(dependent_sha1, {})
self.notify_listeners('dependent_done', dependent, dependencies)
self.logger.info("Finished processing TODO list")
self.notify_listeners('all_done') | python | def find_dependencies(self, dependent_rev, recurse=None):
"""Find all dependencies of the given revision, recursively traversing
the dependency tree if requested.
"""
if recurse is None:
recurse = self.options.recurse
try:
dependent = self.get_commit(dependent_rev)
except InvalidCommitish as e:
abort(e.message())
self.todo.append(dependent)
self.todo_d[dependent.hex] = True
first_time = True
while self.todo:
sha1s = [commit.hex[:8] for commit in self.todo]
if first_time:
self.logger.info("Initial TODO list: %s" % " ".join(sha1s))
first_time = False
else:
self.logger.info(" TODO list now: %s" % " ".join(sha1s))
dependent = self.todo.pop(0)
dependent_sha1 = dependent.hex
del self.todo_d[dependent_sha1]
self.logger.info(" Processing %s from TODO list" %
dependent_sha1[:8])
if dependent_sha1 in self.done_d:
self.logger.info(" %s already done previously" %
dependent_sha1)
continue
self.notify_listeners('new_commit', dependent)
parent = dependent.parents[0]
self.find_dependencies_with_parent(dependent, parent)
self.done.append(dependent_sha1)
self.done_d[dependent_sha1] = True
self.logger.info(" Found all dependencies for %s" %
dependent_sha1[:8])
# A commit won't have any dependencies if it only added new files
dependencies = self.dependencies.get(dependent_sha1, {})
self.notify_listeners('dependent_done', dependent, dependencies)
self.logger.info("Finished processing TODO list")
self.notify_listeners('all_done') | [
"def",
"find_dependencies",
"(",
"self",
",",
"dependent_rev",
",",
"recurse",
"=",
"None",
")",
":",
"if",
"recurse",
"is",
"None",
":",
"recurse",
"=",
"self",
".",
"options",
".",
"recurse",
"try",
":",
"dependent",
"=",
"self",
".",
"get_commit",
"(",
"dependent_rev",
")",
"except",
"InvalidCommitish",
"as",
"e",
":",
"abort",
"(",
"e",
".",
"message",
"(",
")",
")",
"self",
".",
"todo",
".",
"append",
"(",
"dependent",
")",
"self",
".",
"todo_d",
"[",
"dependent",
".",
"hex",
"]",
"=",
"True",
"first_time",
"=",
"True",
"while",
"self",
".",
"todo",
":",
"sha1s",
"=",
"[",
"commit",
".",
"hex",
"[",
":",
"8",
"]",
"for",
"commit",
"in",
"self",
".",
"todo",
"]",
"if",
"first_time",
":",
"self",
".",
"logger",
".",
"info",
"(",
"\"Initial TODO list: %s\"",
"%",
"\" \"",
".",
"join",
"(",
"sha1s",
")",
")",
"first_time",
"=",
"False",
"else",
":",
"self",
".",
"logger",
".",
"info",
"(",
"\" TODO list now: %s\"",
"%",
"\" \"",
".",
"join",
"(",
"sha1s",
")",
")",
"dependent",
"=",
"self",
".",
"todo",
".",
"pop",
"(",
"0",
")",
"dependent_sha1",
"=",
"dependent",
".",
"hex",
"del",
"self",
".",
"todo_d",
"[",
"dependent_sha1",
"]",
"self",
".",
"logger",
".",
"info",
"(",
"\" Processing %s from TODO list\"",
"%",
"dependent_sha1",
"[",
":",
"8",
"]",
")",
"if",
"dependent_sha1",
"in",
"self",
".",
"done_d",
":",
"self",
".",
"logger",
".",
"info",
"(",
"\" %s already done previously\"",
"%",
"dependent_sha1",
")",
"continue",
"self",
".",
"notify_listeners",
"(",
"'new_commit'",
",",
"dependent",
")",
"parent",
"=",
"dependent",
".",
"parents",
"[",
"0",
"]",
"self",
".",
"find_dependencies_with_parent",
"(",
"dependent",
",",
"parent",
")",
"self",
".",
"done",
".",
"append",
"(",
"dependent_sha1",
")",
"self",
".",
"done_d",
"[",
"dependent_sha1",
"]",
"=",
"True",
"self",
".",
"logger",
".",
"info",
"(",
"\" Found all dependencies for %s\"",
"%",
"dependent_sha1",
"[",
":",
"8",
"]",
")",
"# A commit won't have any dependencies if it only added new files",
"dependencies",
"=",
"self",
".",
"dependencies",
".",
"get",
"(",
"dependent_sha1",
",",
"{",
"}",
")",
"self",
".",
"notify_listeners",
"(",
"'dependent_done'",
",",
"dependent",
",",
"dependencies",
")",
"self",
".",
"logger",
".",
"info",
"(",
"\"Finished processing TODO list\"",
")",
"self",
".",
"notify_listeners",
"(",
"'all_done'",
")"
] | Find all dependencies of the given revision, recursively traversing
the dependency tree if requested. | [
"Find",
"all",
"dependencies",
"of",
"the",
"given",
"revision",
"recursively",
"traversing",
"the",
"dependency",
"tree",
"if",
"requested",
"."
] | a00380b8bf1451d8c3405dace8d5927428506eb0 | https://github.com/aspiers/git-deps/blob/a00380b8bf1451d8c3405dace8d5927428506eb0/git_deps/detector.py#L84-L132 | train |
aspiers/git-deps | git_deps/detector.py | DependencyDetector.find_dependencies_with_parent | def find_dependencies_with_parent(self, dependent, parent):
"""Find all dependencies of the given revision caused by the
given parent commit. This will be called multiple times for
merge commits which have multiple parents.
"""
self.logger.info(" Finding dependencies of %s via parent %s" %
(dependent.hex[:8], parent.hex[:8]))
diff = self.repo.diff(parent, dependent,
context_lines=self.options.context_lines)
for patch in diff:
path = patch.delta.old_file.path
self.logger.info(" Examining hunks in %s" % path)
for hunk in patch.hunks:
self.blame_diff_hunk(dependent, parent, path, hunk) | python | def find_dependencies_with_parent(self, dependent, parent):
"""Find all dependencies of the given revision caused by the
given parent commit. This will be called multiple times for
merge commits which have multiple parents.
"""
self.logger.info(" Finding dependencies of %s via parent %s" %
(dependent.hex[:8], parent.hex[:8]))
diff = self.repo.diff(parent, dependent,
context_lines=self.options.context_lines)
for patch in diff:
path = patch.delta.old_file.path
self.logger.info(" Examining hunks in %s" % path)
for hunk in patch.hunks:
self.blame_diff_hunk(dependent, parent, path, hunk) | [
"def",
"find_dependencies_with_parent",
"(",
"self",
",",
"dependent",
",",
"parent",
")",
":",
"self",
".",
"logger",
".",
"info",
"(",
"\" Finding dependencies of %s via parent %s\"",
"%",
"(",
"dependent",
".",
"hex",
"[",
":",
"8",
"]",
",",
"parent",
".",
"hex",
"[",
":",
"8",
"]",
")",
")",
"diff",
"=",
"self",
".",
"repo",
".",
"diff",
"(",
"parent",
",",
"dependent",
",",
"context_lines",
"=",
"self",
".",
"options",
".",
"context_lines",
")",
"for",
"patch",
"in",
"diff",
":",
"path",
"=",
"patch",
".",
"delta",
".",
"old_file",
".",
"path",
"self",
".",
"logger",
".",
"info",
"(",
"\" Examining hunks in %s\"",
"%",
"path",
")",
"for",
"hunk",
"in",
"patch",
".",
"hunks",
":",
"self",
".",
"blame_diff_hunk",
"(",
"dependent",
",",
"parent",
",",
"path",
",",
"hunk",
")"
] | Find all dependencies of the given revision caused by the
given parent commit. This will be called multiple times for
merge commits which have multiple parents. | [
"Find",
"all",
"dependencies",
"of",
"the",
"given",
"revision",
"caused",
"by",
"the",
"given",
"parent",
"commit",
".",
"This",
"will",
"be",
"called",
"multiple",
"times",
"for",
"merge",
"commits",
"which",
"have",
"multiple",
"parents",
"."
] | a00380b8bf1451d8c3405dace8d5927428506eb0 | https://github.com/aspiers/git-deps/blob/a00380b8bf1451d8c3405dace8d5927428506eb0/git_deps/detector.py#L134-L147 | train |
aspiers/git-deps | git_deps/detector.py | DependencyDetector.blame_diff_hunk | def blame_diff_hunk(self, dependent, parent, path, hunk):
"""Run git blame on the parts of the hunk which exist in the
older commit in the diff. The commits generated by git blame
are the commits which the newer commit in the diff depends on,
because without the lines from those commits, the hunk would
not apply correctly.
"""
line_range_before = "-%d,%d" % (hunk.old_start, hunk.old_lines)
line_range_after = "+%d,%d" % (hunk.new_start, hunk.new_lines)
self.logger.info(" Blaming hunk %s @ %s (listed below)" %
(line_range_before, parent.hex[:8]))
if not self.tree_lookup(path, parent):
# This is probably because dependent added a new directory
# which was not previously in the parent.
return
blame = self.run_blame(hunk, parent, path)
dependent_sha1 = dependent.hex
self.register_new_dependent(dependent, dependent_sha1)
line_to_culprit = {}
for line in blame.split('\n'):
self.process_hunk_line(dependent, dependent_sha1, parent,
path, line, line_to_culprit)
self.debug_hunk(line_range_before, line_range_after, hunk,
line_to_culprit) | python | def blame_diff_hunk(self, dependent, parent, path, hunk):
"""Run git blame on the parts of the hunk which exist in the
older commit in the diff. The commits generated by git blame
are the commits which the newer commit in the diff depends on,
because without the lines from those commits, the hunk would
not apply correctly.
"""
line_range_before = "-%d,%d" % (hunk.old_start, hunk.old_lines)
line_range_after = "+%d,%d" % (hunk.new_start, hunk.new_lines)
self.logger.info(" Blaming hunk %s @ %s (listed below)" %
(line_range_before, parent.hex[:8]))
if not self.tree_lookup(path, parent):
# This is probably because dependent added a new directory
# which was not previously in the parent.
return
blame = self.run_blame(hunk, parent, path)
dependent_sha1 = dependent.hex
self.register_new_dependent(dependent, dependent_sha1)
line_to_culprit = {}
for line in blame.split('\n'):
self.process_hunk_line(dependent, dependent_sha1, parent,
path, line, line_to_culprit)
self.debug_hunk(line_range_before, line_range_after, hunk,
line_to_culprit) | [
"def",
"blame_diff_hunk",
"(",
"self",
",",
"dependent",
",",
"parent",
",",
"path",
",",
"hunk",
")",
":",
"line_range_before",
"=",
"\"-%d,%d\"",
"%",
"(",
"hunk",
".",
"old_start",
",",
"hunk",
".",
"old_lines",
")",
"line_range_after",
"=",
"\"+%d,%d\"",
"%",
"(",
"hunk",
".",
"new_start",
",",
"hunk",
".",
"new_lines",
")",
"self",
".",
"logger",
".",
"info",
"(",
"\" Blaming hunk %s @ %s (listed below)\"",
"%",
"(",
"line_range_before",
",",
"parent",
".",
"hex",
"[",
":",
"8",
"]",
")",
")",
"if",
"not",
"self",
".",
"tree_lookup",
"(",
"path",
",",
"parent",
")",
":",
"# This is probably because dependent added a new directory",
"# which was not previously in the parent.",
"return",
"blame",
"=",
"self",
".",
"run_blame",
"(",
"hunk",
",",
"parent",
",",
"path",
")",
"dependent_sha1",
"=",
"dependent",
".",
"hex",
"self",
".",
"register_new_dependent",
"(",
"dependent",
",",
"dependent_sha1",
")",
"line_to_culprit",
"=",
"{",
"}",
"for",
"line",
"in",
"blame",
".",
"split",
"(",
"'\\n'",
")",
":",
"self",
".",
"process_hunk_line",
"(",
"dependent",
",",
"dependent_sha1",
",",
"parent",
",",
"path",
",",
"line",
",",
"line_to_culprit",
")",
"self",
".",
"debug_hunk",
"(",
"line_range_before",
",",
"line_range_after",
",",
"hunk",
",",
"line_to_culprit",
")"
] | Run git blame on the parts of the hunk which exist in the
older commit in the diff. The commits generated by git blame
are the commits which the newer commit in the diff depends on,
because without the lines from those commits, the hunk would
not apply correctly. | [
"Run",
"git",
"blame",
"on",
"the",
"parts",
"of",
"the",
"hunk",
"which",
"exist",
"in",
"the",
"older",
"commit",
"in",
"the",
"diff",
".",
"The",
"commits",
"generated",
"by",
"git",
"blame",
"are",
"the",
"commits",
"which",
"the",
"newer",
"commit",
"in",
"the",
"diff",
"depends",
"on",
"because",
"without",
"the",
"lines",
"from",
"those",
"commits",
"the",
"hunk",
"would",
"not",
"apply",
"correctly",
"."
] | a00380b8bf1451d8c3405dace8d5927428506eb0 | https://github.com/aspiers/git-deps/blob/a00380b8bf1451d8c3405dace8d5927428506eb0/git_deps/detector.py#L149-L178 | train |
aspiers/git-deps | git_deps/detector.py | DependencyDetector.tree_lookup | def tree_lookup(self, target_path, commit):
"""Navigate to the tree or blob object pointed to by the given target
path for the given commit. This is necessary because each git
tree only contains entries for the directory it refers to, not
recursively for all subdirectories.
"""
segments = target_path.split("/")
tree_or_blob = commit.tree
path = ''
while segments:
dirent = segments.pop(0)
if isinstance(tree_or_blob, pygit2.Tree):
if dirent in tree_or_blob:
tree_or_blob = self.repo[tree_or_blob[dirent].oid]
# self.logger.debug(" %s in %s" % (dirent, path))
if path:
path += '/'
path += dirent
else:
# This is probably because we were called on a
# commit whose parent added a new directory.
self.logger.debug(" %s not in %s in %s" %
(dirent, path, commit.hex[:8]))
return None
else:
self.logger.debug(" %s not a tree in %s" %
(tree_or_blob, commit.hex[:8]))
return None
return tree_or_blob | python | def tree_lookup(self, target_path, commit):
"""Navigate to the tree or blob object pointed to by the given target
path for the given commit. This is necessary because each git
tree only contains entries for the directory it refers to, not
recursively for all subdirectories.
"""
segments = target_path.split("/")
tree_or_blob = commit.tree
path = ''
while segments:
dirent = segments.pop(0)
if isinstance(tree_or_blob, pygit2.Tree):
if dirent in tree_or_blob:
tree_or_blob = self.repo[tree_or_blob[dirent].oid]
# self.logger.debug(" %s in %s" % (dirent, path))
if path:
path += '/'
path += dirent
else:
# This is probably because we were called on a
# commit whose parent added a new directory.
self.logger.debug(" %s not in %s in %s" %
(dirent, path, commit.hex[:8]))
return None
else:
self.logger.debug(" %s not a tree in %s" %
(tree_or_blob, commit.hex[:8]))
return None
return tree_or_blob | [
"def",
"tree_lookup",
"(",
"self",
",",
"target_path",
",",
"commit",
")",
":",
"segments",
"=",
"target_path",
".",
"split",
"(",
"\"/\"",
")",
"tree_or_blob",
"=",
"commit",
".",
"tree",
"path",
"=",
"''",
"while",
"segments",
":",
"dirent",
"=",
"segments",
".",
"pop",
"(",
"0",
")",
"if",
"isinstance",
"(",
"tree_or_blob",
",",
"pygit2",
".",
"Tree",
")",
":",
"if",
"dirent",
"in",
"tree_or_blob",
":",
"tree_or_blob",
"=",
"self",
".",
"repo",
"[",
"tree_or_blob",
"[",
"dirent",
"]",
".",
"oid",
"]",
"# self.logger.debug(\" %s in %s\" % (dirent, path))",
"if",
"path",
":",
"path",
"+=",
"'/'",
"path",
"+=",
"dirent",
"else",
":",
"# This is probably because we were called on a",
"# commit whose parent added a new directory.",
"self",
".",
"logger",
".",
"debug",
"(",
"\" %s not in %s in %s\"",
"%",
"(",
"dirent",
",",
"path",
",",
"commit",
".",
"hex",
"[",
":",
"8",
"]",
")",
")",
"return",
"None",
"else",
":",
"self",
".",
"logger",
".",
"debug",
"(",
"\" %s not a tree in %s\"",
"%",
"(",
"tree_or_blob",
",",
"commit",
".",
"hex",
"[",
":",
"8",
"]",
")",
")",
"return",
"None",
"return",
"tree_or_blob"
] | Navigate to the tree or blob object pointed to by the given target
path for the given commit. This is necessary because each git
tree only contains entries for the directory it refers to, not
recursively for all subdirectories. | [
"Navigate",
"to",
"the",
"tree",
"or",
"blob",
"object",
"pointed",
"to",
"by",
"the",
"given",
"target",
"path",
"for",
"the",
"given",
"commit",
".",
"This",
"is",
"necessary",
"because",
"each",
"git",
"tree",
"only",
"contains",
"entries",
"for",
"the",
"directory",
"it",
"refers",
"to",
"not",
"recursively",
"for",
"all",
"subdirectories",
"."
] | a00380b8bf1451d8c3405dace8d5927428506eb0 | https://github.com/aspiers/git-deps/blob/a00380b8bf1451d8c3405dace8d5927428506eb0/git_deps/detector.py#L331-L359 | train |
aspiers/git-deps | git_deps/gitutils.py | GitUtils.abbreviate_sha1 | def abbreviate_sha1(cls, sha1):
"""Uniquely abbreviates the given SHA1."""
# For now we invoke git-rev-parse(1), but hopefully eventually
# we will be able to do this via pygit2.
cmd = ['git', 'rev-parse', '--short', sha1]
# cls.logger.debug(" ".join(cmd))
out = subprocess.check_output(cmd, universal_newlines=True).strip()
# cls.logger.debug(out)
return out | python | def abbreviate_sha1(cls, sha1):
"""Uniquely abbreviates the given SHA1."""
# For now we invoke git-rev-parse(1), but hopefully eventually
# we will be able to do this via pygit2.
cmd = ['git', 'rev-parse', '--short', sha1]
# cls.logger.debug(" ".join(cmd))
out = subprocess.check_output(cmd, universal_newlines=True).strip()
# cls.logger.debug(out)
return out | [
"def",
"abbreviate_sha1",
"(",
"cls",
",",
"sha1",
")",
":",
"# For now we invoke git-rev-parse(1), but hopefully eventually",
"# we will be able to do this via pygit2.",
"cmd",
"=",
"[",
"'git'",
",",
"'rev-parse'",
",",
"'--short'",
",",
"sha1",
"]",
"# cls.logger.debug(\" \".join(cmd))",
"out",
"=",
"subprocess",
".",
"check_output",
"(",
"cmd",
",",
"universal_newlines",
"=",
"True",
")",
".",
"strip",
"(",
")",
"# cls.logger.debug(out)",
"return",
"out"
] | Uniquely abbreviates the given SHA1. | [
"Uniquely",
"abbreviates",
"the",
"given",
"SHA1",
"."
] | a00380b8bf1451d8c3405dace8d5927428506eb0 | https://github.com/aspiers/git-deps/blob/a00380b8bf1451d8c3405dace8d5927428506eb0/git_deps/gitutils.py#L11-L20 | train |
aspiers/git-deps | git_deps/gitutils.py | GitUtils.describe | def describe(cls, sha1):
"""Returns a human-readable representation of the given SHA1."""
# For now we invoke git-describe(1), but eventually we will be
# able to do this via pygit2, since libgit2 already provides
# an API for this:
# https://github.com/libgit2/pygit2/pull/459#issuecomment-68866929
# https://github.com/libgit2/libgit2/pull/2592
cmd = [
'git', 'describe',
'--all', # look for tags and branches
'--long', # remotes/github/master-0-g2b6d591
# '--contains',
# '--abbrev',
sha1
]
# cls.logger.debug(" ".join(cmd))
out = None
try:
out = subprocess.check_output(
cmd, stderr=subprocess.STDOUT, universal_newlines=True)
except subprocess.CalledProcessError as e:
if e.output.find('No tags can describe') != -1:
return ''
raise
out = out.strip()
out = re.sub(r'^(heads|tags|remotes)/', '', out)
# We already have the abbreviated SHA1 from abbreviate_sha1()
out = re.sub(r'-g[0-9a-f]{7,}$', '', out)
# cls.logger.debug(out)
return out | python | def describe(cls, sha1):
"""Returns a human-readable representation of the given SHA1."""
# For now we invoke git-describe(1), but eventually we will be
# able to do this via pygit2, since libgit2 already provides
# an API for this:
# https://github.com/libgit2/pygit2/pull/459#issuecomment-68866929
# https://github.com/libgit2/libgit2/pull/2592
cmd = [
'git', 'describe',
'--all', # look for tags and branches
'--long', # remotes/github/master-0-g2b6d591
# '--contains',
# '--abbrev',
sha1
]
# cls.logger.debug(" ".join(cmd))
out = None
try:
out = subprocess.check_output(
cmd, stderr=subprocess.STDOUT, universal_newlines=True)
except subprocess.CalledProcessError as e:
if e.output.find('No tags can describe') != -1:
return ''
raise
out = out.strip()
out = re.sub(r'^(heads|tags|remotes)/', '', out)
# We already have the abbreviated SHA1 from abbreviate_sha1()
out = re.sub(r'-g[0-9a-f]{7,}$', '', out)
# cls.logger.debug(out)
return out | [
"def",
"describe",
"(",
"cls",
",",
"sha1",
")",
":",
"# For now we invoke git-describe(1), but eventually we will be",
"# able to do this via pygit2, since libgit2 already provides",
"# an API for this:",
"# https://github.com/libgit2/pygit2/pull/459#issuecomment-68866929",
"# https://github.com/libgit2/libgit2/pull/2592",
"cmd",
"=",
"[",
"'git'",
",",
"'describe'",
",",
"'--all'",
",",
"# look for tags and branches",
"'--long'",
",",
"# remotes/github/master-0-g2b6d591",
"# '--contains',",
"# '--abbrev',",
"sha1",
"]",
"# cls.logger.debug(\" \".join(cmd))",
"out",
"=",
"None",
"try",
":",
"out",
"=",
"subprocess",
".",
"check_output",
"(",
"cmd",
",",
"stderr",
"=",
"subprocess",
".",
"STDOUT",
",",
"universal_newlines",
"=",
"True",
")",
"except",
"subprocess",
".",
"CalledProcessError",
"as",
"e",
":",
"if",
"e",
".",
"output",
".",
"find",
"(",
"'No tags can describe'",
")",
"!=",
"-",
"1",
":",
"return",
"''",
"raise",
"out",
"=",
"out",
".",
"strip",
"(",
")",
"out",
"=",
"re",
".",
"sub",
"(",
"r'^(heads|tags|remotes)/'",
",",
"''",
",",
"out",
")",
"# We already have the abbreviated SHA1 from abbreviate_sha1()",
"out",
"=",
"re",
".",
"sub",
"(",
"r'-g[0-9a-f]{7,}$'",
",",
"''",
",",
"out",
")",
"# cls.logger.debug(out)",
"return",
"out"
] | Returns a human-readable representation of the given SHA1. | [
"Returns",
"a",
"human",
"-",
"readable",
"representation",
"of",
"the",
"given",
"SHA1",
"."
] | a00380b8bf1451d8c3405dace8d5927428506eb0 | https://github.com/aspiers/git-deps/blob/a00380b8bf1451d8c3405dace8d5927428506eb0/git_deps/gitutils.py#L23-L54 | train |
aspiers/git-deps | git_deps/gitutils.py | GitUtils.refs_to | def refs_to(cls, sha1, repo):
"""Returns all refs pointing to the given SHA1."""
matching = []
for refname in repo.listall_references():
symref = repo.lookup_reference(refname)
dref = symref.resolve()
oid = dref.target
commit = repo.get(oid)
if commit.hex == sha1:
matching.append(symref.shorthand)
return matching | python | def refs_to(cls, sha1, repo):
"""Returns all refs pointing to the given SHA1."""
matching = []
for refname in repo.listall_references():
symref = repo.lookup_reference(refname)
dref = symref.resolve()
oid = dref.target
commit = repo.get(oid)
if commit.hex == sha1:
matching.append(symref.shorthand)
return matching | [
"def",
"refs_to",
"(",
"cls",
",",
"sha1",
",",
"repo",
")",
":",
"matching",
"=",
"[",
"]",
"for",
"refname",
"in",
"repo",
".",
"listall_references",
"(",
")",
":",
"symref",
"=",
"repo",
".",
"lookup_reference",
"(",
"refname",
")",
"dref",
"=",
"symref",
".",
"resolve",
"(",
")",
"oid",
"=",
"dref",
".",
"target",
"commit",
"=",
"repo",
".",
"get",
"(",
"oid",
")",
"if",
"commit",
".",
"hex",
"==",
"sha1",
":",
"matching",
".",
"append",
"(",
"symref",
".",
"shorthand",
")",
"return",
"matching"
] | Returns all refs pointing to the given SHA1. | [
"Returns",
"all",
"refs",
"pointing",
"to",
"the",
"given",
"SHA1",
"."
] | a00380b8bf1451d8c3405dace8d5927428506eb0 | https://github.com/aspiers/git-deps/blob/a00380b8bf1451d8c3405dace8d5927428506eb0/git_deps/gitutils.py#L69-L80 | train |
aspiers/git-deps | git_deps/listener/json.py | JSONDependencyListener.add_commit | def add_commit(self, commit):
"""Adds the commit to the commits array if it doesn't already exist,
and returns the commit's index in the array.
"""
sha1 = commit.hex
if sha1 in self._commits:
return self._commits[sha1]
title, separator, body = commit.message.partition("\n")
commit = {
'explored': False,
'sha1': sha1,
'name': GitUtils.abbreviate_sha1(sha1),
'describe': GitUtils.describe(sha1),
'refs': GitUtils.refs_to(sha1, self.repo()),
'author_name': commit.author.name,
'author_mail': commit.author.email,
'author_time': commit.author.time,
'author_offset': commit.author.offset,
'committer_name': commit.committer.name,
'committer_mail': commit.committer.email,
'committer_time': commit.committer.time,
'committer_offset': commit.committer.offset,
# 'message': commit.message,
'title': title,
'separator': separator,
'body': body.lstrip("\n"),
}
self._json['commits'].append(commit)
self._commits[sha1] = len(self._json['commits']) - 1
return self._commits[sha1] | python | def add_commit(self, commit):
"""Adds the commit to the commits array if it doesn't already exist,
and returns the commit's index in the array.
"""
sha1 = commit.hex
if sha1 in self._commits:
return self._commits[sha1]
title, separator, body = commit.message.partition("\n")
commit = {
'explored': False,
'sha1': sha1,
'name': GitUtils.abbreviate_sha1(sha1),
'describe': GitUtils.describe(sha1),
'refs': GitUtils.refs_to(sha1, self.repo()),
'author_name': commit.author.name,
'author_mail': commit.author.email,
'author_time': commit.author.time,
'author_offset': commit.author.offset,
'committer_name': commit.committer.name,
'committer_mail': commit.committer.email,
'committer_time': commit.committer.time,
'committer_offset': commit.committer.offset,
# 'message': commit.message,
'title': title,
'separator': separator,
'body': body.lstrip("\n"),
}
self._json['commits'].append(commit)
self._commits[sha1] = len(self._json['commits']) - 1
return self._commits[sha1] | [
"def",
"add_commit",
"(",
"self",
",",
"commit",
")",
":",
"sha1",
"=",
"commit",
".",
"hex",
"if",
"sha1",
"in",
"self",
".",
"_commits",
":",
"return",
"self",
".",
"_commits",
"[",
"sha1",
"]",
"title",
",",
"separator",
",",
"body",
"=",
"commit",
".",
"message",
".",
"partition",
"(",
"\"\\n\"",
")",
"commit",
"=",
"{",
"'explored'",
":",
"False",
",",
"'sha1'",
":",
"sha1",
",",
"'name'",
":",
"GitUtils",
".",
"abbreviate_sha1",
"(",
"sha1",
")",
",",
"'describe'",
":",
"GitUtils",
".",
"describe",
"(",
"sha1",
")",
",",
"'refs'",
":",
"GitUtils",
".",
"refs_to",
"(",
"sha1",
",",
"self",
".",
"repo",
"(",
")",
")",
",",
"'author_name'",
":",
"commit",
".",
"author",
".",
"name",
",",
"'author_mail'",
":",
"commit",
".",
"author",
".",
"email",
",",
"'author_time'",
":",
"commit",
".",
"author",
".",
"time",
",",
"'author_offset'",
":",
"commit",
".",
"author",
".",
"offset",
",",
"'committer_name'",
":",
"commit",
".",
"committer",
".",
"name",
",",
"'committer_mail'",
":",
"commit",
".",
"committer",
".",
"email",
",",
"'committer_time'",
":",
"commit",
".",
"committer",
".",
"time",
",",
"'committer_offset'",
":",
"commit",
".",
"committer",
".",
"offset",
",",
"# 'message': commit.message,",
"'title'",
":",
"title",
",",
"'separator'",
":",
"separator",
",",
"'body'",
":",
"body",
".",
"lstrip",
"(",
"\"\\n\"",
")",
",",
"}",
"self",
".",
"_json",
"[",
"'commits'",
"]",
".",
"append",
"(",
"commit",
")",
"self",
".",
"_commits",
"[",
"sha1",
"]",
"=",
"len",
"(",
"self",
".",
"_json",
"[",
"'commits'",
"]",
")",
"-",
"1",
"return",
"self",
".",
"_commits",
"[",
"sha1",
"]"
] | Adds the commit to the commits array if it doesn't already exist,
and returns the commit's index in the array. | [
"Adds",
"the",
"commit",
"to",
"the",
"commits",
"array",
"if",
"it",
"doesn",
"t",
"already",
"exist",
"and",
"returns",
"the",
"commit",
"s",
"index",
"in",
"the",
"array",
"."
] | a00380b8bf1451d8c3405dace8d5927428506eb0 | https://github.com/aspiers/git-deps/blob/a00380b8bf1451d8c3405dace8d5927428506eb0/git_deps/listener/json.py#L30-L59 | train |
gocardless/gocardless-pro-python | gocardless_pro/api_client.py | ApiClient.get | def get(self, path, params=None, headers=None):
"""Perform a GET request, optionally providing query-string params.
Args:
path (str): A path that gets appended to ``base_url``.
params (dict, optional): Dictionary of param names to values.
Example:
api_client.get('/users', params={'active': True})
Returns:
A requests ``Response`` object.
"""
response = requests.get(
self._url_for(path),
params=params,
headers=self._headers(headers)
)
self._handle_errors(response)
return response | python | def get(self, path, params=None, headers=None):
"""Perform a GET request, optionally providing query-string params.
Args:
path (str): A path that gets appended to ``base_url``.
params (dict, optional): Dictionary of param names to values.
Example:
api_client.get('/users', params={'active': True})
Returns:
A requests ``Response`` object.
"""
response = requests.get(
self._url_for(path),
params=params,
headers=self._headers(headers)
)
self._handle_errors(response)
return response | [
"def",
"get",
"(",
"self",
",",
"path",
",",
"params",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"response",
"=",
"requests",
".",
"get",
"(",
"self",
".",
"_url_for",
"(",
"path",
")",
",",
"params",
"=",
"params",
",",
"headers",
"=",
"self",
".",
"_headers",
"(",
"headers",
")",
")",
"self",
".",
"_handle_errors",
"(",
"response",
")",
"return",
"response"
] | Perform a GET request, optionally providing query-string params.
Args:
path (str): A path that gets appended to ``base_url``.
params (dict, optional): Dictionary of param names to values.
Example:
api_client.get('/users', params={'active': True})
Returns:
A requests ``Response`` object. | [
"Perform",
"a",
"GET",
"request",
"optionally",
"providing",
"query",
"-",
"string",
"params",
"."
] | 7b57f037d14875eea8d659084eeb524f3ce17f4a | https://github.com/gocardless/gocardless-pro-python/blob/7b57f037d14875eea8d659084eeb524f3ce17f4a/gocardless_pro/api_client.py#L30-L49 | train |
gocardless/gocardless-pro-python | gocardless_pro/api_client.py | ApiClient.post | def post(self, path, body, headers=None):
"""Perform a POST request, providing a body, which will be JSON-encoded.
Args:
path (str): A path that gets appended to ``base_url``.
body (dict): Dictionary that will be JSON-encoded and sent as the body.
Example:
api_client.post('/users', body={'name': 'Billy Jean'})
Returns:
A requests ``Response`` object.
"""
response = requests.post(
self._url_for(path),
data=json.dumps(body),
headers=self._headers(headers)
)
self._handle_errors(response)
return response | python | def post(self, path, body, headers=None):
"""Perform a POST request, providing a body, which will be JSON-encoded.
Args:
path (str): A path that gets appended to ``base_url``.
body (dict): Dictionary that will be JSON-encoded and sent as the body.
Example:
api_client.post('/users', body={'name': 'Billy Jean'})
Returns:
A requests ``Response`` object.
"""
response = requests.post(
self._url_for(path),
data=json.dumps(body),
headers=self._headers(headers)
)
self._handle_errors(response)
return response | [
"def",
"post",
"(",
"self",
",",
"path",
",",
"body",
",",
"headers",
"=",
"None",
")",
":",
"response",
"=",
"requests",
".",
"post",
"(",
"self",
".",
"_url_for",
"(",
"path",
")",
",",
"data",
"=",
"json",
".",
"dumps",
"(",
"body",
")",
",",
"headers",
"=",
"self",
".",
"_headers",
"(",
"headers",
")",
")",
"self",
".",
"_handle_errors",
"(",
"response",
")",
"return",
"response"
] | Perform a POST request, providing a body, which will be JSON-encoded.
Args:
path (str): A path that gets appended to ``base_url``.
body (dict): Dictionary that will be JSON-encoded and sent as the body.
Example:
api_client.post('/users', body={'name': 'Billy Jean'})
Returns:
A requests ``Response`` object. | [
"Perform",
"a",
"POST",
"request",
"providing",
"a",
"body",
"which",
"will",
"be",
"JSON",
"-",
"encoded",
"."
] | 7b57f037d14875eea8d659084eeb524f3ce17f4a | https://github.com/gocardless/gocardless-pro-python/blob/7b57f037d14875eea8d659084eeb524f3ce17f4a/gocardless_pro/api_client.py#L51-L71 | train |
gocardless/gocardless-pro-python | gocardless_pro/services/creditor_bank_accounts_service.py | CreditorBankAccountsService.create | def create(self,params=None, headers=None):
"""Create a creditor bank account.
Creates a new creditor bank account object.
Args:
params (dict, optional): Request body.
Returns:
ListResponse of CreditorBankAccount instances
"""
path = '/creditor_bank_accounts'
if params is not None:
params = {self._envelope_key(): params}
try:
response = self._perform_request('POST', path, params, headers,
retry_failures=True)
except errors.IdempotentCreationConflictError as err:
return self.get(identity=err.conflicting_resource_id,
params=params,
headers=headers)
return self._resource_for(response) | python | def create(self,params=None, headers=None):
"""Create a creditor bank account.
Creates a new creditor bank account object.
Args:
params (dict, optional): Request body.
Returns:
ListResponse of CreditorBankAccount instances
"""
path = '/creditor_bank_accounts'
if params is not None:
params = {self._envelope_key(): params}
try:
response = self._perform_request('POST', path, params, headers,
retry_failures=True)
except errors.IdempotentCreationConflictError as err:
return self.get(identity=err.conflicting_resource_id,
params=params,
headers=headers)
return self._resource_for(response) | [
"def",
"create",
"(",
"self",
",",
"params",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"path",
"=",
"'/creditor_bank_accounts'",
"if",
"params",
"is",
"not",
"None",
":",
"params",
"=",
"{",
"self",
".",
"_envelope_key",
"(",
")",
":",
"params",
"}",
"try",
":",
"response",
"=",
"self",
".",
"_perform_request",
"(",
"'POST'",
",",
"path",
",",
"params",
",",
"headers",
",",
"retry_failures",
"=",
"True",
")",
"except",
"errors",
".",
"IdempotentCreationConflictError",
"as",
"err",
":",
"return",
"self",
".",
"get",
"(",
"identity",
"=",
"err",
".",
"conflicting_resource_id",
",",
"params",
"=",
"params",
",",
"headers",
"=",
"headers",
")",
"return",
"self",
".",
"_resource_for",
"(",
"response",
")"
] | Create a creditor bank account.
Creates a new creditor bank account object.
Args:
params (dict, optional): Request body.
Returns:
ListResponse of CreditorBankAccount instances | [
"Create",
"a",
"creditor",
"bank",
"account",
"."
] | 7b57f037d14875eea8d659084eeb524f3ce17f4a | https://github.com/gocardless/gocardless-pro-python/blob/7b57f037d14875eea8d659084eeb524f3ce17f4a/gocardless_pro/services/creditor_bank_accounts_service.py#L20-L43 | train |
gocardless/gocardless-pro-python | gocardless_pro/services/creditor_bank_accounts_service.py | CreditorBankAccountsService.list | def list(self,params=None, headers=None):
"""List creditor bank accounts.
Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
creditor bank accounts.
Args:
params (dict, optional): Query string parameters.
Returns:
CreditorBankAccount
"""
path = '/creditor_bank_accounts'
response = self._perform_request('GET', path, params, headers,
retry_failures=True)
return self._resource_for(response) | python | def list(self,params=None, headers=None):
"""List creditor bank accounts.
Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
creditor bank accounts.
Args:
params (dict, optional): Query string parameters.
Returns:
CreditorBankAccount
"""
path = '/creditor_bank_accounts'
response = self._perform_request('GET', path, params, headers,
retry_failures=True)
return self._resource_for(response) | [
"def",
"list",
"(",
"self",
",",
"params",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"path",
"=",
"'/creditor_bank_accounts'",
"response",
"=",
"self",
".",
"_perform_request",
"(",
"'GET'",
",",
"path",
",",
"params",
",",
"headers",
",",
"retry_failures",
"=",
"True",
")",
"return",
"self",
".",
"_resource_for",
"(",
"response",
")"
] | List creditor bank accounts.
Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
creditor bank accounts.
Args:
params (dict, optional): Query string parameters.
Returns:
CreditorBankAccount | [
"List",
"creditor",
"bank",
"accounts",
"."
] | 7b57f037d14875eea8d659084eeb524f3ce17f4a | https://github.com/gocardless/gocardless-pro-python/blob/7b57f037d14875eea8d659084eeb524f3ce17f4a/gocardless_pro/services/creditor_bank_accounts_service.py#L46-L63 | train |
gocardless/gocardless-pro-python | gocardless_pro/services/creditor_bank_accounts_service.py | CreditorBankAccountsService.get | def get(self,identity,params=None, headers=None):
"""Get a single creditor bank account.
Retrieves the details of an existing creditor bank account.
Args:
identity (string): Unique identifier, beginning with "BA".
params (dict, optional): Query string parameters.
Returns:
ListResponse of CreditorBankAccount instances
"""
path = self._sub_url_params('/creditor_bank_accounts/:identity', {
'identity': identity,
})
response = self._perform_request('GET', path, params, headers,
retry_failures=True)
return self._resource_for(response) | python | def get(self,identity,params=None, headers=None):
"""Get a single creditor bank account.
Retrieves the details of an existing creditor bank account.
Args:
identity (string): Unique identifier, beginning with "BA".
params (dict, optional): Query string parameters.
Returns:
ListResponse of CreditorBankAccount instances
"""
path = self._sub_url_params('/creditor_bank_accounts/:identity', {
'identity': identity,
})
response = self._perform_request('GET', path, params, headers,
retry_failures=True)
return self._resource_for(response) | [
"def",
"get",
"(",
"self",
",",
"identity",
",",
"params",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"path",
"=",
"self",
".",
"_sub_url_params",
"(",
"'/creditor_bank_accounts/:identity'",
",",
"{",
"'identity'",
":",
"identity",
",",
"}",
")",
"response",
"=",
"self",
".",
"_perform_request",
"(",
"'GET'",
",",
"path",
",",
"params",
",",
"headers",
",",
"retry_failures",
"=",
"True",
")",
"return",
"self",
".",
"_resource_for",
"(",
"response",
")"
] | Get a single creditor bank account.
Retrieves the details of an existing creditor bank account.
Args:
identity (string): Unique identifier, beginning with "BA".
params (dict, optional): Query string parameters.
Returns:
ListResponse of CreditorBankAccount instances | [
"Get",
"a",
"single",
"creditor",
"bank",
"account",
"."
] | 7b57f037d14875eea8d659084eeb524f3ce17f4a | https://github.com/gocardless/gocardless-pro-python/blob/7b57f037d14875eea8d659084eeb524f3ce17f4a/gocardless_pro/services/creditor_bank_accounts_service.py#L72-L92 | train |
gocardless/gocardless-pro-python | gocardless_pro/services/creditor_bank_accounts_service.py | CreditorBankAccountsService.disable | def disable(self,identity,params=None, headers=None):
"""Disable a creditor bank account.
Immediately disables the bank account, no money can be paid out to a
disabled account.
This will return a `disable_failed` error if the bank account has
already been disabled.
A disabled bank account can be re-enabled by creating a new bank
account resource with the same details.
Args:
identity (string): Unique identifier, beginning with "BA".
params (dict, optional): Request body.
Returns:
ListResponse of CreditorBankAccount instances
"""
path = self._sub_url_params('/creditor_bank_accounts/:identity/actions/disable', {
'identity': identity,
})
if params is not None:
params = {'data': params}
response = self._perform_request('POST', path, params, headers,
retry_failures=False)
return self._resource_for(response) | python | def disable(self,identity,params=None, headers=None):
"""Disable a creditor bank account.
Immediately disables the bank account, no money can be paid out to a
disabled account.
This will return a `disable_failed` error if the bank account has
already been disabled.
A disabled bank account can be re-enabled by creating a new bank
account resource with the same details.
Args:
identity (string): Unique identifier, beginning with "BA".
params (dict, optional): Request body.
Returns:
ListResponse of CreditorBankAccount instances
"""
path = self._sub_url_params('/creditor_bank_accounts/:identity/actions/disable', {
'identity': identity,
})
if params is not None:
params = {'data': params}
response = self._perform_request('POST', path, params, headers,
retry_failures=False)
return self._resource_for(response) | [
"def",
"disable",
"(",
"self",
",",
"identity",
",",
"params",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"path",
"=",
"self",
".",
"_sub_url_params",
"(",
"'/creditor_bank_accounts/:identity/actions/disable'",
",",
"{",
"'identity'",
":",
"identity",
",",
"}",
")",
"if",
"params",
"is",
"not",
"None",
":",
"params",
"=",
"{",
"'data'",
":",
"params",
"}",
"response",
"=",
"self",
".",
"_perform_request",
"(",
"'POST'",
",",
"path",
",",
"params",
",",
"headers",
",",
"retry_failures",
"=",
"False",
")",
"return",
"self",
".",
"_resource_for",
"(",
"response",
")"
] | Disable a creditor bank account.
Immediately disables the bank account, no money can be paid out to a
disabled account.
This will return a `disable_failed` error if the bank account has
already been disabled.
A disabled bank account can be re-enabled by creating a new bank
account resource with the same details.
Args:
identity (string): Unique identifier, beginning with "BA".
params (dict, optional): Request body.
Returns:
ListResponse of CreditorBankAccount instances | [
"Disable",
"a",
"creditor",
"bank",
"account",
"."
] | 7b57f037d14875eea8d659084eeb524f3ce17f4a | https://github.com/gocardless/gocardless-pro-python/blob/7b57f037d14875eea8d659084eeb524f3ce17f4a/gocardless_pro/services/creditor_bank_accounts_service.py#L95-L123 | train |
gocardless/gocardless-pro-python | gocardless_pro/services/mandate_pdfs_service.py | MandatePdfsService.create | def create(self,params=None, headers=None):
"""Create a mandate PDF.
Generates a PDF mandate and returns its temporary URL.
Customer and bank account details can be left blank (for a blank
mandate), provided manually, or inferred from the ID of an existing
[mandate](#core-endpoints-mandates).
By default, we'll generate PDF mandates in English.
To generate a PDF mandate in another language, set the
`Accept-Language` header when creating the PDF mandate to the relevant
[ISO 639-1](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
language code supported for the scheme.
| Scheme | Supported languages
|
| :--------------- |
:-------------------------------------------------------------------------------------------------------------------------------------------
|
| Autogiro | English (`en`), Swedish (`sv`)
|
| Bacs | English (`en`)
|
| BECS | English (`en`)
|
| BECS NZ | English (`en`)
|
| Betalingsservice | Danish (`da`), English (`en`)
|
| PAD | English (`en`)
|
| SEPA Core | Danish (`da`), Dutch (`nl`), English (`en`),
French (`fr`), German (`de`), Italian (`it`), Portuguese (`pt`),
Spanish (`es`), Swedish (`sv`) |
Args:
params (dict, optional): Request body.
Returns:
ListResponse of MandatePdf instances
"""
path = '/mandate_pdfs'
if params is not None:
params = {self._envelope_key(): params}
response = self._perform_request('POST', path, params, headers,
retry_failures=True)
return self._resource_for(response) | python | def create(self,params=None, headers=None):
"""Create a mandate PDF.
Generates a PDF mandate and returns its temporary URL.
Customer and bank account details can be left blank (for a blank
mandate), provided manually, or inferred from the ID of an existing
[mandate](#core-endpoints-mandates).
By default, we'll generate PDF mandates in English.
To generate a PDF mandate in another language, set the
`Accept-Language` header when creating the PDF mandate to the relevant
[ISO 639-1](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
language code supported for the scheme.
| Scheme | Supported languages
|
| :--------------- |
:-------------------------------------------------------------------------------------------------------------------------------------------
|
| Autogiro | English (`en`), Swedish (`sv`)
|
| Bacs | English (`en`)
|
| BECS | English (`en`)
|
| BECS NZ | English (`en`)
|
| Betalingsservice | Danish (`da`), English (`en`)
|
| PAD | English (`en`)
|
| SEPA Core | Danish (`da`), Dutch (`nl`), English (`en`),
French (`fr`), German (`de`), Italian (`it`), Portuguese (`pt`),
Spanish (`es`), Swedish (`sv`) |
Args:
params (dict, optional): Request body.
Returns:
ListResponse of MandatePdf instances
"""
path = '/mandate_pdfs'
if params is not None:
params = {self._envelope_key(): params}
response = self._perform_request('POST', path, params, headers,
retry_failures=True)
return self._resource_for(response) | [
"def",
"create",
"(",
"self",
",",
"params",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"path",
"=",
"'/mandate_pdfs'",
"if",
"params",
"is",
"not",
"None",
":",
"params",
"=",
"{",
"self",
".",
"_envelope_key",
"(",
")",
":",
"params",
"}",
"response",
"=",
"self",
".",
"_perform_request",
"(",
"'POST'",
",",
"path",
",",
"params",
",",
"headers",
",",
"retry_failures",
"=",
"True",
")",
"return",
"self",
".",
"_resource_for",
"(",
"response",
")"
] | Create a mandate PDF.
Generates a PDF mandate and returns its temporary URL.
Customer and bank account details can be left blank (for a blank
mandate), provided manually, or inferred from the ID of an existing
[mandate](#core-endpoints-mandates).
By default, we'll generate PDF mandates in English.
To generate a PDF mandate in another language, set the
`Accept-Language` header when creating the PDF mandate to the relevant
[ISO 639-1](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
language code supported for the scheme.
| Scheme | Supported languages
|
| :--------------- |
:-------------------------------------------------------------------------------------------------------------------------------------------
|
| Autogiro | English (`en`), Swedish (`sv`)
|
| Bacs | English (`en`)
|
| BECS | English (`en`)
|
| BECS NZ | English (`en`)
|
| Betalingsservice | Danish (`da`), English (`en`)
|
| PAD | English (`en`)
|
| SEPA Core | Danish (`da`), Dutch (`nl`), English (`en`),
French (`fr`), German (`de`), Italian (`it`), Portuguese (`pt`),
Spanish (`es`), Swedish (`sv`) |
Args:
params (dict, optional): Request body.
Returns:
ListResponse of MandatePdf instances | [
"Create",
"a",
"mandate",
"PDF",
"."
] | 7b57f037d14875eea8d659084eeb524f3ce17f4a | https://github.com/gocardless/gocardless-pro-python/blob/7b57f037d14875eea8d659084eeb524f3ce17f4a/gocardless_pro/services/mandate_pdfs_service.py#L20-L77 | train |
gocardless/gocardless-pro-python | gocardless_pro/services/payments_service.py | PaymentsService.update | def update(self,identity,params=None, headers=None):
"""Update a payment.
Updates a payment object. This accepts only the metadata parameter.
Args:
identity (string): Unique identifier, beginning with "PM".
params (dict, optional): Request body.
Returns:
ListResponse of Payment instances
"""
path = self._sub_url_params('/payments/:identity', {
'identity': identity,
})
if params is not None:
params = {self._envelope_key(): params}
response = self._perform_request('PUT', path, params, headers,
retry_failures=True)
return self._resource_for(response) | python | def update(self,identity,params=None, headers=None):
"""Update a payment.
Updates a payment object. This accepts only the metadata parameter.
Args:
identity (string): Unique identifier, beginning with "PM".
params (dict, optional): Request body.
Returns:
ListResponse of Payment instances
"""
path = self._sub_url_params('/payments/:identity', {
'identity': identity,
})
if params is not None:
params = {self._envelope_key(): params}
response = self._perform_request('PUT', path, params, headers,
retry_failures=True)
return self._resource_for(response) | [
"def",
"update",
"(",
"self",
",",
"identity",
",",
"params",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"path",
"=",
"self",
".",
"_sub_url_params",
"(",
"'/payments/:identity'",
",",
"{",
"'identity'",
":",
"identity",
",",
"}",
")",
"if",
"params",
"is",
"not",
"None",
":",
"params",
"=",
"{",
"self",
".",
"_envelope_key",
"(",
")",
":",
"params",
"}",
"response",
"=",
"self",
".",
"_perform_request",
"(",
"'PUT'",
",",
"path",
",",
"params",
",",
"headers",
",",
"retry_failures",
"=",
"True",
")",
"return",
"self",
".",
"_resource_for",
"(",
"response",
")"
] | Update a payment.
Updates a payment object. This accepts only the metadata parameter.
Args:
identity (string): Unique identifier, beginning with "PM".
params (dict, optional): Request body.
Returns:
ListResponse of Payment instances | [
"Update",
"a",
"payment",
"."
] | 7b57f037d14875eea8d659084eeb524f3ce17f4a | https://github.com/gocardless/gocardless-pro-python/blob/7b57f037d14875eea8d659084eeb524f3ce17f4a/gocardless_pro/services/payments_service.py#L101-L123 | train |
prashnts/hues | hues/console.py | Config.resolve_config | def resolve_config(self):
'''Resolve configuration params to native instances'''
conf = self.load_config(self.force_default)
for k in conf['hues']:
conf['hues'][k] = getattr(KEYWORDS, conf['hues'][k])
as_tuples = lambda name, obj: namedtuple(name, obj.keys())(**obj)
self.hues = as_tuples('Hues', conf['hues'])
self.opts = as_tuples('Options', conf['options'])
self.labels = as_tuples('Labels', conf['labels']) | python | def resolve_config(self):
'''Resolve configuration params to native instances'''
conf = self.load_config(self.force_default)
for k in conf['hues']:
conf['hues'][k] = getattr(KEYWORDS, conf['hues'][k])
as_tuples = lambda name, obj: namedtuple(name, obj.keys())(**obj)
self.hues = as_tuples('Hues', conf['hues'])
self.opts = as_tuples('Options', conf['options'])
self.labels = as_tuples('Labels', conf['labels']) | [
"def",
"resolve_config",
"(",
"self",
")",
":",
"conf",
"=",
"self",
".",
"load_config",
"(",
"self",
".",
"force_default",
")",
"for",
"k",
"in",
"conf",
"[",
"'hues'",
"]",
":",
"conf",
"[",
"'hues'",
"]",
"[",
"k",
"]",
"=",
"getattr",
"(",
"KEYWORDS",
",",
"conf",
"[",
"'hues'",
"]",
"[",
"k",
"]",
")",
"as_tuples",
"=",
"lambda",
"name",
",",
"obj",
":",
"namedtuple",
"(",
"name",
",",
"obj",
".",
"keys",
"(",
")",
")",
"(",
"*",
"*",
"obj",
")",
"self",
".",
"hues",
"=",
"as_tuples",
"(",
"'Hues'",
",",
"conf",
"[",
"'hues'",
"]",
")",
"self",
".",
"opts",
"=",
"as_tuples",
"(",
"'Options'",
",",
"conf",
"[",
"'options'",
"]",
")",
"self",
".",
"labels",
"=",
"as_tuples",
"(",
"'Labels'",
",",
"conf",
"[",
"'labels'",
"]",
")"
] | Resolve configuration params to native instances | [
"Resolve",
"configuration",
"params",
"to",
"native",
"instances"
] | 888049a41e3f2bf33546e53ef3c17494ee8c8790 | https://github.com/prashnts/hues/blob/888049a41e3f2bf33546e53ef3c17494ee8c8790/hues/console.py#L72-L81 | train |
prashnts/hues | hues/dpda.py | apply | def apply(funcs, stack):
'''Apply functions to the stack, passing the resulting stack to next state.'''
return reduce(lambda x, y: y(x), funcs, stack) | python | def apply(funcs, stack):
'''Apply functions to the stack, passing the resulting stack to next state.'''
return reduce(lambda x, y: y(x), funcs, stack) | [
"def",
"apply",
"(",
"funcs",
",",
"stack",
")",
":",
"return",
"reduce",
"(",
"lambda",
"x",
",",
"y",
":",
"y",
"(",
"x",
")",
",",
"funcs",
",",
"stack",
")"
] | Apply functions to the stack, passing the resulting stack to next state. | [
"Apply",
"functions",
"to",
"the",
"stack",
"passing",
"the",
"resulting",
"stack",
"to",
"next",
"state",
"."
] | 888049a41e3f2bf33546e53ef3c17494ee8c8790 | https://github.com/prashnts/hues/blob/888049a41e3f2bf33546e53ef3c17494ee8c8790/hues/dpda.py#L41-L43 | train |
prashnts/hues | hues/huestr.py | colorize | def colorize(string, stack):
'''Apply optimal ANSI escape sequences to the string.'''
codes = optimize(stack)
if len(codes):
prefix = SEQ % ';'.join(map(str, codes))
suffix = SEQ % STYLE.reset
return prefix + string + suffix
else:
return string | python | def colorize(string, stack):
'''Apply optimal ANSI escape sequences to the string.'''
codes = optimize(stack)
if len(codes):
prefix = SEQ % ';'.join(map(str, codes))
suffix = SEQ % STYLE.reset
return prefix + string + suffix
else:
return string | [
"def",
"colorize",
"(",
"string",
",",
"stack",
")",
":",
"codes",
"=",
"optimize",
"(",
"stack",
")",
"if",
"len",
"(",
"codes",
")",
":",
"prefix",
"=",
"SEQ",
"%",
"';'",
".",
"join",
"(",
"map",
"(",
"str",
",",
"codes",
")",
")",
"suffix",
"=",
"SEQ",
"%",
"STYLE",
".",
"reset",
"return",
"prefix",
"+",
"string",
"+",
"suffix",
"else",
":",
"return",
"string"
] | Apply optimal ANSI escape sequences to the string. | [
"Apply",
"optimal",
"ANSI",
"escape",
"sequences",
"to",
"the",
"string",
"."
] | 888049a41e3f2bf33546e53ef3c17494ee8c8790 | https://github.com/prashnts/hues/blob/888049a41e3f2bf33546e53ef3c17494ee8c8790/hues/huestr.py#L21-L29 | train |
SpikeInterface/spiketoolkit | spiketoolkit/comparison/comparisontools.py | compute_agreement_score | def compute_agreement_score(num_matches, num1, num2):
"""
Agreement score is used as a criteria to match unit1 and unit2.
"""
denom = num1 + num2 - num_matches
if denom == 0:
return 0
return num_matches / denom | python | def compute_agreement_score(num_matches, num1, num2):
"""
Agreement score is used as a criteria to match unit1 and unit2.
"""
denom = num1 + num2 - num_matches
if denom == 0:
return 0
return num_matches / denom | [
"def",
"compute_agreement_score",
"(",
"num_matches",
",",
"num1",
",",
"num2",
")",
":",
"denom",
"=",
"num1",
"+",
"num2",
"-",
"num_matches",
"if",
"denom",
"==",
"0",
":",
"return",
"0",
"return",
"num_matches",
"/",
"denom"
] | Agreement score is used as a criteria to match unit1 and unit2. | [
"Agreement",
"score",
"is",
"used",
"as",
"a",
"criteria",
"to",
"match",
"unit1",
"and",
"unit2",
"."
] | f7c054383d1ebca640966b057c087fa187955d13 | https://github.com/SpikeInterface/spiketoolkit/blob/f7c054383d1ebca640966b057c087fa187955d13/spiketoolkit/comparison/comparisontools.py#L25-L32 | train |
SpikeInterface/spiketoolkit | spiketoolkit/sorters/launcher.py | collect_results | def collect_results(working_folder):
"""
Collect results in a working_folder.
The output is nested dict[rec_name][sorter_name] of SortingExtrator.
"""
results = {}
working_folder = Path(working_folder)
output_folders = working_folder/'output_folders'
for rec_name in os.listdir(output_folders):
if not os.path.isdir(output_folders / rec_name):
continue
# print(rec_name)
results[rec_name] = {}
for sorter_name in os.listdir(output_folders / rec_name):
# print(' ', sorter_name)
output_folder = output_folders / rec_name / sorter_name
#~ print(output_folder)
if not os.path.isdir(output_folder):
continue
SorterClass = sorter_dict[sorter_name]
results[rec_name][sorter_name] = SorterClass.get_result_from_folder(output_folder)
return results | python | def collect_results(working_folder):
"""
Collect results in a working_folder.
The output is nested dict[rec_name][sorter_name] of SortingExtrator.
"""
results = {}
working_folder = Path(working_folder)
output_folders = working_folder/'output_folders'
for rec_name in os.listdir(output_folders):
if not os.path.isdir(output_folders / rec_name):
continue
# print(rec_name)
results[rec_name] = {}
for sorter_name in os.listdir(output_folders / rec_name):
# print(' ', sorter_name)
output_folder = output_folders / rec_name / sorter_name
#~ print(output_folder)
if not os.path.isdir(output_folder):
continue
SorterClass = sorter_dict[sorter_name]
results[rec_name][sorter_name] = SorterClass.get_result_from_folder(output_folder)
return results | [
"def",
"collect_results",
"(",
"working_folder",
")",
":",
"results",
"=",
"{",
"}",
"working_folder",
"=",
"Path",
"(",
"working_folder",
")",
"output_folders",
"=",
"working_folder",
"/",
"'output_folders'",
"for",
"rec_name",
"in",
"os",
".",
"listdir",
"(",
"output_folders",
")",
":",
"if",
"not",
"os",
".",
"path",
".",
"isdir",
"(",
"output_folders",
"/",
"rec_name",
")",
":",
"continue",
"# print(rec_name)",
"results",
"[",
"rec_name",
"]",
"=",
"{",
"}",
"for",
"sorter_name",
"in",
"os",
".",
"listdir",
"(",
"output_folders",
"/",
"rec_name",
")",
":",
"# print(' ', sorter_name)",
"output_folder",
"=",
"output_folders",
"/",
"rec_name",
"/",
"sorter_name",
"#~ print(output_folder)",
"if",
"not",
"os",
".",
"path",
".",
"isdir",
"(",
"output_folder",
")",
":",
"continue",
"SorterClass",
"=",
"sorter_dict",
"[",
"sorter_name",
"]",
"results",
"[",
"rec_name",
"]",
"[",
"sorter_name",
"]",
"=",
"SorterClass",
".",
"get_result_from_folder",
"(",
"output_folder",
")",
"return",
"results"
] | Collect results in a working_folder.
The output is nested dict[rec_name][sorter_name] of SortingExtrator. | [
"Collect",
"results",
"in",
"a",
"working_folder",
"."
] | f7c054383d1ebca640966b057c087fa187955d13 | https://github.com/SpikeInterface/spiketoolkit/blob/f7c054383d1ebca640966b057c087fa187955d13/spiketoolkit/sorters/launcher.py#L181-L206 | train |
SpikeInterface/spiketoolkit | spiketoolkit/sorters/sorterlist.py | run_sorter | def run_sorter(sorter_name_or_class, recording, output_folder=None, delete_output_folder=False,
grouping_property=None, parallel=False, debug=False, **params):
"""
Generic function to run a sorter via function approach.
2 Usage with name or class:
by name:
>>> sorting = run_sorter('tridesclous', recording)
by class:
>>> sorting = run_sorter(TridesclousSorter, recording)
"""
if isinstance(sorter_name_or_class, str):
SorterClass = sorter_dict[sorter_name_or_class]
elif sorter_name_or_class in sorter_full_list:
SorterClass = sorter_name_or_class
else:
raise(ValueError('Unknown sorter'))
sorter = SorterClass(recording=recording, output_folder=output_folder, grouping_property=grouping_property,
parallel=parallel, debug=debug, delete_output_folder=delete_output_folder)
sorter.set_params(**params)
sorter.run()
sortingextractor = sorter.get_result()
return sortingextractor | python | def run_sorter(sorter_name_or_class, recording, output_folder=None, delete_output_folder=False,
grouping_property=None, parallel=False, debug=False, **params):
"""
Generic function to run a sorter via function approach.
2 Usage with name or class:
by name:
>>> sorting = run_sorter('tridesclous', recording)
by class:
>>> sorting = run_sorter(TridesclousSorter, recording)
"""
if isinstance(sorter_name_or_class, str):
SorterClass = sorter_dict[sorter_name_or_class]
elif sorter_name_or_class in sorter_full_list:
SorterClass = sorter_name_or_class
else:
raise(ValueError('Unknown sorter'))
sorter = SorterClass(recording=recording, output_folder=output_folder, grouping_property=grouping_property,
parallel=parallel, debug=debug, delete_output_folder=delete_output_folder)
sorter.set_params(**params)
sorter.run()
sortingextractor = sorter.get_result()
return sortingextractor | [
"def",
"run_sorter",
"(",
"sorter_name_or_class",
",",
"recording",
",",
"output_folder",
"=",
"None",
",",
"delete_output_folder",
"=",
"False",
",",
"grouping_property",
"=",
"None",
",",
"parallel",
"=",
"False",
",",
"debug",
"=",
"False",
",",
"*",
"*",
"params",
")",
":",
"if",
"isinstance",
"(",
"sorter_name_or_class",
",",
"str",
")",
":",
"SorterClass",
"=",
"sorter_dict",
"[",
"sorter_name_or_class",
"]",
"elif",
"sorter_name_or_class",
"in",
"sorter_full_list",
":",
"SorterClass",
"=",
"sorter_name_or_class",
"else",
":",
"raise",
"(",
"ValueError",
"(",
"'Unknown sorter'",
")",
")",
"sorter",
"=",
"SorterClass",
"(",
"recording",
"=",
"recording",
",",
"output_folder",
"=",
"output_folder",
",",
"grouping_property",
"=",
"grouping_property",
",",
"parallel",
"=",
"parallel",
",",
"debug",
"=",
"debug",
",",
"delete_output_folder",
"=",
"delete_output_folder",
")",
"sorter",
".",
"set_params",
"(",
"*",
"*",
"params",
")",
"sorter",
".",
"run",
"(",
")",
"sortingextractor",
"=",
"sorter",
".",
"get_result",
"(",
")",
"return",
"sortingextractor"
] | Generic function to run a sorter via function approach.
2 Usage with name or class:
by name:
>>> sorting = run_sorter('tridesclous', recording)
by class:
>>> sorting = run_sorter(TridesclousSorter, recording) | [
"Generic",
"function",
"to",
"run",
"a",
"sorter",
"via",
"function",
"approach",
"."
] | f7c054383d1ebca640966b057c087fa187955d13 | https://github.com/SpikeInterface/spiketoolkit/blob/f7c054383d1ebca640966b057c087fa187955d13/spiketoolkit/sorters/sorterlist.py#L29-L57 | train |
SpikeInterface/spiketoolkit | spiketoolkit/comparison/sortingcomparison.py | compute_performance | def compute_performance(SC, verbose=True, output='dict'):
"""
Return some performance value for comparison.
Parameters
-------
SC: SortingComparison instance
The SortingComparison
verbose: bool
Display on console or not
output: dict or pandas
Returns
----------
performance: dict or pandas.Serie depending output param
"""
counts = SC._counts
tp_rate = float(counts['TP']) / counts['TOT_ST1'] * 100
cl_rate = float(counts['CL']) / counts['TOT_ST1'] * 100
fn_rate = float(counts['FN']) / counts['TOT_ST1'] * 100
fp_st1 = float(counts['FP']) / counts['TOT_ST1'] * 100
fp_st2 = float(counts['FP']) / counts['TOT_ST2'] * 100
accuracy = tp_rate / (tp_rate + fn_rate + fp_st1) * 100
sensitivity = tp_rate / (tp_rate + fn_rate) * 100
miss_rate = fn_rate / (tp_rate + fn_rate) * 100
precision = tp_rate / (tp_rate + fp_st1) * 100
false_discovery_rate = fp_st1 / (tp_rate + fp_st1) * 100
performance = {'tp': tp_rate, 'cl': cl_rate, 'fn': fn_rate, 'fp_st1': fp_st1, 'fp_st2': fp_st2,
'accuracy': accuracy, 'sensitivity': sensitivity, 'precision': precision, 'miss_rate': miss_rate,
'false_disc_rate': false_discovery_rate}
if verbose:
txt = _txt_performance.format(**performance)
print(txt)
if output == 'dict':
return performance
elif output == 'pandas':
return pd.Series(performance) | python | def compute_performance(SC, verbose=True, output='dict'):
"""
Return some performance value for comparison.
Parameters
-------
SC: SortingComparison instance
The SortingComparison
verbose: bool
Display on console or not
output: dict or pandas
Returns
----------
performance: dict or pandas.Serie depending output param
"""
counts = SC._counts
tp_rate = float(counts['TP']) / counts['TOT_ST1'] * 100
cl_rate = float(counts['CL']) / counts['TOT_ST1'] * 100
fn_rate = float(counts['FN']) / counts['TOT_ST1'] * 100
fp_st1 = float(counts['FP']) / counts['TOT_ST1'] * 100
fp_st2 = float(counts['FP']) / counts['TOT_ST2'] * 100
accuracy = tp_rate / (tp_rate + fn_rate + fp_st1) * 100
sensitivity = tp_rate / (tp_rate + fn_rate) * 100
miss_rate = fn_rate / (tp_rate + fn_rate) * 100
precision = tp_rate / (tp_rate + fp_st1) * 100
false_discovery_rate = fp_st1 / (tp_rate + fp_st1) * 100
performance = {'tp': tp_rate, 'cl': cl_rate, 'fn': fn_rate, 'fp_st1': fp_st1, 'fp_st2': fp_st2,
'accuracy': accuracy, 'sensitivity': sensitivity, 'precision': precision, 'miss_rate': miss_rate,
'false_disc_rate': false_discovery_rate}
if verbose:
txt = _txt_performance.format(**performance)
print(txt)
if output == 'dict':
return performance
elif output == 'pandas':
return pd.Series(performance) | [
"def",
"compute_performance",
"(",
"SC",
",",
"verbose",
"=",
"True",
",",
"output",
"=",
"'dict'",
")",
":",
"counts",
"=",
"SC",
".",
"_counts",
"tp_rate",
"=",
"float",
"(",
"counts",
"[",
"'TP'",
"]",
")",
"/",
"counts",
"[",
"'TOT_ST1'",
"]",
"*",
"100",
"cl_rate",
"=",
"float",
"(",
"counts",
"[",
"'CL'",
"]",
")",
"/",
"counts",
"[",
"'TOT_ST1'",
"]",
"*",
"100",
"fn_rate",
"=",
"float",
"(",
"counts",
"[",
"'FN'",
"]",
")",
"/",
"counts",
"[",
"'TOT_ST1'",
"]",
"*",
"100",
"fp_st1",
"=",
"float",
"(",
"counts",
"[",
"'FP'",
"]",
")",
"/",
"counts",
"[",
"'TOT_ST1'",
"]",
"*",
"100",
"fp_st2",
"=",
"float",
"(",
"counts",
"[",
"'FP'",
"]",
")",
"/",
"counts",
"[",
"'TOT_ST2'",
"]",
"*",
"100",
"accuracy",
"=",
"tp_rate",
"/",
"(",
"tp_rate",
"+",
"fn_rate",
"+",
"fp_st1",
")",
"*",
"100",
"sensitivity",
"=",
"tp_rate",
"/",
"(",
"tp_rate",
"+",
"fn_rate",
")",
"*",
"100",
"miss_rate",
"=",
"fn_rate",
"/",
"(",
"tp_rate",
"+",
"fn_rate",
")",
"*",
"100",
"precision",
"=",
"tp_rate",
"/",
"(",
"tp_rate",
"+",
"fp_st1",
")",
"*",
"100",
"false_discovery_rate",
"=",
"fp_st1",
"/",
"(",
"tp_rate",
"+",
"fp_st1",
")",
"*",
"100",
"performance",
"=",
"{",
"'tp'",
":",
"tp_rate",
",",
"'cl'",
":",
"cl_rate",
",",
"'fn'",
":",
"fn_rate",
",",
"'fp_st1'",
":",
"fp_st1",
",",
"'fp_st2'",
":",
"fp_st2",
",",
"'accuracy'",
":",
"accuracy",
",",
"'sensitivity'",
":",
"sensitivity",
",",
"'precision'",
":",
"precision",
",",
"'miss_rate'",
":",
"miss_rate",
",",
"'false_disc_rate'",
":",
"false_discovery_rate",
"}",
"if",
"verbose",
":",
"txt",
"=",
"_txt_performance",
".",
"format",
"(",
"*",
"*",
"performance",
")",
"print",
"(",
"txt",
")",
"if",
"output",
"==",
"'dict'",
":",
"return",
"performance",
"elif",
"output",
"==",
"'pandas'",
":",
"return",
"pd",
".",
"Series",
"(",
"performance",
")"
] | Return some performance value for comparison.
Parameters
-------
SC: SortingComparison instance
The SortingComparison
verbose: bool
Display on console or not
output: dict or pandas
Returns
----------
performance: dict or pandas.Serie depending output param | [
"Return",
"some",
"performance",
"value",
"for",
"comparison",
"."
] | f7c054383d1ebca640966b057c087fa187955d13 | https://github.com/SpikeInterface/spiketoolkit/blob/f7c054383d1ebca640966b057c087fa187955d13/spiketoolkit/comparison/sortingcomparison.py#L279-L325 | train |
uber/rides-python-sdk | uber_rides/errors.py | HTTPError._complex_response_to_error_adapter | def _complex_response_to_error_adapter(self, body):
"""Convert a list of error responses."""
meta = body.get('meta')
errors = body.get('errors')
e = []
for error in errors:
status = error['status']
code = error['code']
title = error['title']
e.append(ErrorDetails(status, code, title))
return e, meta | python | def _complex_response_to_error_adapter(self, body):
"""Convert a list of error responses."""
meta = body.get('meta')
errors = body.get('errors')
e = []
for error in errors:
status = error['status']
code = error['code']
title = error['title']
e.append(ErrorDetails(status, code, title))
return e, meta | [
"def",
"_complex_response_to_error_adapter",
"(",
"self",
",",
"body",
")",
":",
"meta",
"=",
"body",
".",
"get",
"(",
"'meta'",
")",
"errors",
"=",
"body",
".",
"get",
"(",
"'errors'",
")",
"e",
"=",
"[",
"]",
"for",
"error",
"in",
"errors",
":",
"status",
"=",
"error",
"[",
"'status'",
"]",
"code",
"=",
"error",
"[",
"'code'",
"]",
"title",
"=",
"error",
"[",
"'title'",
"]",
"e",
".",
"append",
"(",
"ErrorDetails",
"(",
"status",
",",
"code",
",",
"title",
")",
")",
"return",
"e",
",",
"meta"
] | Convert a list of error responses. | [
"Convert",
"a",
"list",
"of",
"error",
"responses",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/errors.py#L53-L66 | train |
uber/rides-python-sdk | uber_rides/errors.py | ServerError._adapt_response | def _adapt_response(self, response):
"""Convert various error responses to standardized ErrorDetails."""
errors, meta = super(ServerError, self)._adapt_response(response)
return errors[0], meta | python | def _adapt_response(self, response):
"""Convert various error responses to standardized ErrorDetails."""
errors, meta = super(ServerError, self)._adapt_response(response)
return errors[0], meta | [
"def",
"_adapt_response",
"(",
"self",
",",
"response",
")",
":",
"errors",
",",
"meta",
"=",
"super",
"(",
"ServerError",
",",
"self",
")",
".",
"_adapt_response",
"(",
"response",
")",
"return",
"errors",
"[",
"0",
"]",
",",
"meta"
] | Convert various error responses to standardized ErrorDetails. | [
"Convert",
"various",
"error",
"responses",
"to",
"standardized",
"ErrorDetails",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/errors.py#L141-L144 | train |
uber/rides-python-sdk | uber_rides/request.py | Request._prepare | def _prepare(self):
"""Builds a URL and return a PreparedRequest.
Returns
(requests.PreparedRequest)
Raises
UberIllegalState (APIError)
"""
if self.method not in http.ALLOWED_METHODS:
raise UberIllegalState('Unsupported HTTP Method.')
api_host = self.api_host
headers = self._build_headers(self.method, self.auth_session)
url = build_url(api_host, self.path)
data, params = generate_data(self.method, self.args)
return generate_prepared_request(
self.method,
url,
headers,
data,
params,
self.handlers,
) | python | def _prepare(self):
"""Builds a URL and return a PreparedRequest.
Returns
(requests.PreparedRequest)
Raises
UberIllegalState (APIError)
"""
if self.method not in http.ALLOWED_METHODS:
raise UberIllegalState('Unsupported HTTP Method.')
api_host = self.api_host
headers = self._build_headers(self.method, self.auth_session)
url = build_url(api_host, self.path)
data, params = generate_data(self.method, self.args)
return generate_prepared_request(
self.method,
url,
headers,
data,
params,
self.handlers,
) | [
"def",
"_prepare",
"(",
"self",
")",
":",
"if",
"self",
".",
"method",
"not",
"in",
"http",
".",
"ALLOWED_METHODS",
":",
"raise",
"UberIllegalState",
"(",
"'Unsupported HTTP Method.'",
")",
"api_host",
"=",
"self",
".",
"api_host",
"headers",
"=",
"self",
".",
"_build_headers",
"(",
"self",
".",
"method",
",",
"self",
".",
"auth_session",
")",
"url",
"=",
"build_url",
"(",
"api_host",
",",
"self",
".",
"path",
")",
"data",
",",
"params",
"=",
"generate_data",
"(",
"self",
".",
"method",
",",
"self",
".",
"args",
")",
"return",
"generate_prepared_request",
"(",
"self",
".",
"method",
",",
"url",
",",
"headers",
",",
"data",
",",
"params",
",",
"self",
".",
"handlers",
",",
")"
] | Builds a URL and return a PreparedRequest.
Returns
(requests.PreparedRequest)
Raises
UberIllegalState (APIError) | [
"Builds",
"a",
"URL",
"and",
"return",
"a",
"PreparedRequest",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/request.py#L98-L122 | train |
uber/rides-python-sdk | uber_rides/request.py | Request._send | def _send(self, prepared_request):
"""Send a PreparedRequest to the server.
Parameters
prepared_request (requests.PreparedRequest)
Returns
(Response)
A Response object, whichcontains a server's
response to an HTTP request.
"""
session = Session()
response = session.send(prepared_request)
return Response(response) | python | def _send(self, prepared_request):
"""Send a PreparedRequest to the server.
Parameters
prepared_request (requests.PreparedRequest)
Returns
(Response)
A Response object, whichcontains a server's
response to an HTTP request.
"""
session = Session()
response = session.send(prepared_request)
return Response(response) | [
"def",
"_send",
"(",
"self",
",",
"prepared_request",
")",
":",
"session",
"=",
"Session",
"(",
")",
"response",
"=",
"session",
".",
"send",
"(",
"prepared_request",
")",
"return",
"Response",
"(",
"response",
")"
] | Send a PreparedRequest to the server.
Parameters
prepared_request (requests.PreparedRequest)
Returns
(Response)
A Response object, whichcontains a server's
response to an HTTP request. | [
"Send",
"a",
"PreparedRequest",
"to",
"the",
"server",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/request.py#L124-L137 | train |
uber/rides-python-sdk | uber_rides/request.py | Request._build_headers | def _build_headers(self, method, auth_session):
"""Create headers for the request.
Parameters
method (str)
HTTP method (e.g. 'POST').
auth_session (Session)
The Session object containing OAuth 2.0 credentials.
Returns
headers (dict)
Dictionary of access headers to attach to request.
Raises
UberIllegalState (ApiError)
Raised if headers are invalid.
"""
token_type = auth_session.token_type
if auth_session.server_token:
token = auth_session.server_token
else:
token = auth_session.oauth2credential.access_token
if not self._authorization_headers_valid(token_type, token):
message = 'Invalid token_type or token.'
raise UberIllegalState(message)
headers = {
'Authorization': ' '.join([token_type, token]),
'X-Uber-User-Agent': 'Python Rides SDK v{}'.format(LIB_VERSION),
}
if method in http.BODY_METHODS:
headers.update(http.DEFAULT_CONTENT_HEADERS)
return headers | python | def _build_headers(self, method, auth_session):
"""Create headers for the request.
Parameters
method (str)
HTTP method (e.g. 'POST').
auth_session (Session)
The Session object containing OAuth 2.0 credentials.
Returns
headers (dict)
Dictionary of access headers to attach to request.
Raises
UberIllegalState (ApiError)
Raised if headers are invalid.
"""
token_type = auth_session.token_type
if auth_session.server_token:
token = auth_session.server_token
else:
token = auth_session.oauth2credential.access_token
if not self._authorization_headers_valid(token_type, token):
message = 'Invalid token_type or token.'
raise UberIllegalState(message)
headers = {
'Authorization': ' '.join([token_type, token]),
'X-Uber-User-Agent': 'Python Rides SDK v{}'.format(LIB_VERSION),
}
if method in http.BODY_METHODS:
headers.update(http.DEFAULT_CONTENT_HEADERS)
return headers | [
"def",
"_build_headers",
"(",
"self",
",",
"method",
",",
"auth_session",
")",
":",
"token_type",
"=",
"auth_session",
".",
"token_type",
"if",
"auth_session",
".",
"server_token",
":",
"token",
"=",
"auth_session",
".",
"server_token",
"else",
":",
"token",
"=",
"auth_session",
".",
"oauth2credential",
".",
"access_token",
"if",
"not",
"self",
".",
"_authorization_headers_valid",
"(",
"token_type",
",",
"token",
")",
":",
"message",
"=",
"'Invalid token_type or token.'",
"raise",
"UberIllegalState",
"(",
"message",
")",
"headers",
"=",
"{",
"'Authorization'",
":",
"' '",
".",
"join",
"(",
"[",
"token_type",
",",
"token",
"]",
")",
",",
"'X-Uber-User-Agent'",
":",
"'Python Rides SDK v{}'",
".",
"format",
"(",
"LIB_VERSION",
")",
",",
"}",
"if",
"method",
"in",
"http",
".",
"BODY_METHODS",
":",
"headers",
".",
"update",
"(",
"http",
".",
"DEFAULT_CONTENT_HEADERS",
")",
"return",
"headers"
] | Create headers for the request.
Parameters
method (str)
HTTP method (e.g. 'POST').
auth_session (Session)
The Session object containing OAuth 2.0 credentials.
Returns
headers (dict)
Dictionary of access headers to attach to request.
Raises
UberIllegalState (ApiError)
Raised if headers are invalid. | [
"Create",
"headers",
"for",
"the",
"request",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/request.py#L154-L190 | train |
uber/rides-python-sdk | example/authorize_driver.py | authorization_code_grant_flow | def authorization_code_grant_flow(credentials, storage_filename):
"""Get an access token through Authorization Code Grant.
Parameters
credentials (dict)
All your app credentials and information
imported from the configuration file.
storage_filename (str)
Filename to store OAuth 2.0 Credentials.
Returns
(UberRidesClient)
An UberRidesClient with OAuth 2.0 Credentials.
"""
auth_flow = AuthorizationCodeGrant(
credentials.get('client_id'),
credentials.get('scopes'),
credentials.get('client_secret'),
credentials.get('redirect_url'),
)
auth_url = auth_flow.get_authorization_url()
login_message = 'Login as a driver and grant access by going to:\n\n{}\n'
login_message = login_message.format(auth_url)
response_print(login_message)
redirect_url = 'Copy the URL you are redirected to and paste here:\n\n'
result = input(redirect_url).strip()
try:
session = auth_flow.get_session(result)
except (ClientError, UberIllegalState) as error:
fail_print(error)
return
credential = session.oauth2credential
credential_data = {
'client_id': credential.client_id,
'redirect_url': credential.redirect_url,
'access_token': credential.access_token,
'expires_in_seconds': credential.expires_in_seconds,
'scopes': list(credential.scopes),
'grant_type': credential.grant_type,
'client_secret': credential.client_secret,
'refresh_token': credential.refresh_token,
}
with open(storage_filename, 'w') as yaml_file:
yaml_file.write(safe_dump(credential_data, default_flow_style=False))
return UberRidesClient(session, sandbox_mode=True) | python | def authorization_code_grant_flow(credentials, storage_filename):
"""Get an access token through Authorization Code Grant.
Parameters
credentials (dict)
All your app credentials and information
imported from the configuration file.
storage_filename (str)
Filename to store OAuth 2.0 Credentials.
Returns
(UberRidesClient)
An UberRidesClient with OAuth 2.0 Credentials.
"""
auth_flow = AuthorizationCodeGrant(
credentials.get('client_id'),
credentials.get('scopes'),
credentials.get('client_secret'),
credentials.get('redirect_url'),
)
auth_url = auth_flow.get_authorization_url()
login_message = 'Login as a driver and grant access by going to:\n\n{}\n'
login_message = login_message.format(auth_url)
response_print(login_message)
redirect_url = 'Copy the URL you are redirected to and paste here:\n\n'
result = input(redirect_url).strip()
try:
session = auth_flow.get_session(result)
except (ClientError, UberIllegalState) as error:
fail_print(error)
return
credential = session.oauth2credential
credential_data = {
'client_id': credential.client_id,
'redirect_url': credential.redirect_url,
'access_token': credential.access_token,
'expires_in_seconds': credential.expires_in_seconds,
'scopes': list(credential.scopes),
'grant_type': credential.grant_type,
'client_secret': credential.client_secret,
'refresh_token': credential.refresh_token,
}
with open(storage_filename, 'w') as yaml_file:
yaml_file.write(safe_dump(credential_data, default_flow_style=False))
return UberRidesClient(session, sandbox_mode=True) | [
"def",
"authorization_code_grant_flow",
"(",
"credentials",
",",
"storage_filename",
")",
":",
"auth_flow",
"=",
"AuthorizationCodeGrant",
"(",
"credentials",
".",
"get",
"(",
"'client_id'",
")",
",",
"credentials",
".",
"get",
"(",
"'scopes'",
")",
",",
"credentials",
".",
"get",
"(",
"'client_secret'",
")",
",",
"credentials",
".",
"get",
"(",
"'redirect_url'",
")",
",",
")",
"auth_url",
"=",
"auth_flow",
".",
"get_authorization_url",
"(",
")",
"login_message",
"=",
"'Login as a driver and grant access by going to:\\n\\n{}\\n'",
"login_message",
"=",
"login_message",
".",
"format",
"(",
"auth_url",
")",
"response_print",
"(",
"login_message",
")",
"redirect_url",
"=",
"'Copy the URL you are redirected to and paste here:\\n\\n'",
"result",
"=",
"input",
"(",
"redirect_url",
")",
".",
"strip",
"(",
")",
"try",
":",
"session",
"=",
"auth_flow",
".",
"get_session",
"(",
"result",
")",
"except",
"(",
"ClientError",
",",
"UberIllegalState",
")",
"as",
"error",
":",
"fail_print",
"(",
"error",
")",
"return",
"credential",
"=",
"session",
".",
"oauth2credential",
"credential_data",
"=",
"{",
"'client_id'",
":",
"credential",
".",
"client_id",
",",
"'redirect_url'",
":",
"credential",
".",
"redirect_url",
",",
"'access_token'",
":",
"credential",
".",
"access_token",
",",
"'expires_in_seconds'",
":",
"credential",
".",
"expires_in_seconds",
",",
"'scopes'",
":",
"list",
"(",
"credential",
".",
"scopes",
")",
",",
"'grant_type'",
":",
"credential",
".",
"grant_type",
",",
"'client_secret'",
":",
"credential",
".",
"client_secret",
",",
"'refresh_token'",
":",
"credential",
".",
"refresh_token",
",",
"}",
"with",
"open",
"(",
"storage_filename",
",",
"'w'",
")",
"as",
"yaml_file",
":",
"yaml_file",
".",
"write",
"(",
"safe_dump",
"(",
"credential_data",
",",
"default_flow_style",
"=",
"False",
")",
")",
"return",
"UberRidesClient",
"(",
"session",
",",
"sandbox_mode",
"=",
"True",
")"
] | Get an access token through Authorization Code Grant.
Parameters
credentials (dict)
All your app credentials and information
imported from the configuration file.
storage_filename (str)
Filename to store OAuth 2.0 Credentials.
Returns
(UberRidesClient)
An UberRidesClient with OAuth 2.0 Credentials. | [
"Get",
"an",
"access",
"token",
"through",
"Authorization",
"Code",
"Grant",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/example/authorize_driver.py#L58-L110 | train |
uber/rides-python-sdk | uber_rides/auth.py | _request_access_token | def _request_access_token(
grant_type,
client_id=None,
client_secret=None,
scopes=None,
code=None,
redirect_url=None,
refresh_token=None
):
"""Make an HTTP POST to request an access token.
Parameters
grant_type (str)
Either 'client_credientials' (Client Credentials Grant)
or 'authorization_code' (Authorization Code Grant).
client_id (str)
Your app's Client ID.
client_secret (str)
Your app's Client Secret.
scopes (set)
Set of permission scopes to request.
(e.g. {'profile', 'history'})
code (str)
The authorization code to switch for an access token.
Only used in Authorization Code Grant.
redirect_url (str)
The URL that the Uber server will redirect to.
refresh_token (str)
Refresh token used to get a new access token.
Only used for Authorization Code Grant.
Returns
(requests.Response)
Successful HTTP response from a 'POST' to request
an access token.
Raises
ClientError (APIError)
Thrown if there was an HTTP error.
"""
url = build_url(auth.AUTH_HOST, auth.ACCESS_TOKEN_PATH)
if isinstance(scopes, set):
scopes = ' '.join(scopes)
args = {
'grant_type': grant_type,
'client_id': client_id,
'client_secret': client_secret,
'scope': scopes,
'code': code,
'redirect_uri': redirect_url,
'refresh_token': refresh_token,
}
response = post(url=url, data=args)
if response.status_code == codes.ok:
return response
message = 'Failed to request access token: {}.'
message = message.format(response.reason)
raise ClientError(response, message) | python | def _request_access_token(
grant_type,
client_id=None,
client_secret=None,
scopes=None,
code=None,
redirect_url=None,
refresh_token=None
):
"""Make an HTTP POST to request an access token.
Parameters
grant_type (str)
Either 'client_credientials' (Client Credentials Grant)
or 'authorization_code' (Authorization Code Grant).
client_id (str)
Your app's Client ID.
client_secret (str)
Your app's Client Secret.
scopes (set)
Set of permission scopes to request.
(e.g. {'profile', 'history'})
code (str)
The authorization code to switch for an access token.
Only used in Authorization Code Grant.
redirect_url (str)
The URL that the Uber server will redirect to.
refresh_token (str)
Refresh token used to get a new access token.
Only used for Authorization Code Grant.
Returns
(requests.Response)
Successful HTTP response from a 'POST' to request
an access token.
Raises
ClientError (APIError)
Thrown if there was an HTTP error.
"""
url = build_url(auth.AUTH_HOST, auth.ACCESS_TOKEN_PATH)
if isinstance(scopes, set):
scopes = ' '.join(scopes)
args = {
'grant_type': grant_type,
'client_id': client_id,
'client_secret': client_secret,
'scope': scopes,
'code': code,
'redirect_uri': redirect_url,
'refresh_token': refresh_token,
}
response = post(url=url, data=args)
if response.status_code == codes.ok:
return response
message = 'Failed to request access token: {}.'
message = message.format(response.reason)
raise ClientError(response, message) | [
"def",
"_request_access_token",
"(",
"grant_type",
",",
"client_id",
"=",
"None",
",",
"client_secret",
"=",
"None",
",",
"scopes",
"=",
"None",
",",
"code",
"=",
"None",
",",
"redirect_url",
"=",
"None",
",",
"refresh_token",
"=",
"None",
")",
":",
"url",
"=",
"build_url",
"(",
"auth",
".",
"AUTH_HOST",
",",
"auth",
".",
"ACCESS_TOKEN_PATH",
")",
"if",
"isinstance",
"(",
"scopes",
",",
"set",
")",
":",
"scopes",
"=",
"' '",
".",
"join",
"(",
"scopes",
")",
"args",
"=",
"{",
"'grant_type'",
":",
"grant_type",
",",
"'client_id'",
":",
"client_id",
",",
"'client_secret'",
":",
"client_secret",
",",
"'scope'",
":",
"scopes",
",",
"'code'",
":",
"code",
",",
"'redirect_uri'",
":",
"redirect_url",
",",
"'refresh_token'",
":",
"refresh_token",
",",
"}",
"response",
"=",
"post",
"(",
"url",
"=",
"url",
",",
"data",
"=",
"args",
")",
"if",
"response",
".",
"status_code",
"==",
"codes",
".",
"ok",
":",
"return",
"response",
"message",
"=",
"'Failed to request access token: {}.'",
"message",
"=",
"message",
".",
"format",
"(",
"response",
".",
"reason",
")",
"raise",
"ClientError",
"(",
"response",
",",
"message",
")"
] | Make an HTTP POST to request an access token.
Parameters
grant_type (str)
Either 'client_credientials' (Client Credentials Grant)
or 'authorization_code' (Authorization Code Grant).
client_id (str)
Your app's Client ID.
client_secret (str)
Your app's Client Secret.
scopes (set)
Set of permission scopes to request.
(e.g. {'profile', 'history'})
code (str)
The authorization code to switch for an access token.
Only used in Authorization Code Grant.
redirect_url (str)
The URL that the Uber server will redirect to.
refresh_token (str)
Refresh token used to get a new access token.
Only used for Authorization Code Grant.
Returns
(requests.Response)
Successful HTTP response from a 'POST' to request
an access token.
Raises
ClientError (APIError)
Thrown if there was an HTTP error. | [
"Make",
"an",
"HTTP",
"POST",
"to",
"request",
"an",
"access",
"token",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/auth.py#L447-L509 | train |
uber/rides-python-sdk | uber_rides/auth.py | refresh_access_token | def refresh_access_token(credential):
"""Use a refresh token to request a new access token.
Not suported for access tokens obtained via Implicit Grant.
Parameters
credential (OAuth2Credential)
An authorized user's OAuth 2.0 credentials.
Returns
(Session)
A new Session object with refreshed OAuth 2.0 credentials.
Raises
UberIllegalState (APIError)
Raised if OAuth 2.0 grant type does not support
refresh tokens.
"""
if credential.grant_type == auth.AUTHORIZATION_CODE_GRANT:
response = _request_access_token(
grant_type=auth.REFRESH_TOKEN,
client_id=credential.client_id,
client_secret=credential.client_secret,
redirect_url=credential.redirect_url,
refresh_token=credential.refresh_token,
)
oauth2credential = OAuth2Credential.make_from_response(
response=response,
grant_type=credential.grant_type,
client_id=credential.client_id,
client_secret=credential.client_secret,
redirect_url=credential.redirect_url,
)
return Session(oauth2credential=oauth2credential)
elif credential.grant_type == auth.CLIENT_CREDENTIALS_GRANT:
response = _request_access_token(
grant_type=auth.CLIENT_CREDENTIALS_GRANT,
client_id=credential.client_id,
client_secret=credential.client_secret,
scopes=credential.scopes,
)
oauth2credential = OAuth2Credential.make_from_response(
response=response,
grant_type=credential.grant_type,
client_id=credential.client_id,
client_secret=credential.client_secret,
)
return Session(oauth2credential=oauth2credential)
message = '{} Grant Type does not support Refresh Tokens.'
message = message.format(credential.grant_type)
raise UberIllegalState(message) | python | def refresh_access_token(credential):
"""Use a refresh token to request a new access token.
Not suported for access tokens obtained via Implicit Grant.
Parameters
credential (OAuth2Credential)
An authorized user's OAuth 2.0 credentials.
Returns
(Session)
A new Session object with refreshed OAuth 2.0 credentials.
Raises
UberIllegalState (APIError)
Raised if OAuth 2.0 grant type does not support
refresh tokens.
"""
if credential.grant_type == auth.AUTHORIZATION_CODE_GRANT:
response = _request_access_token(
grant_type=auth.REFRESH_TOKEN,
client_id=credential.client_id,
client_secret=credential.client_secret,
redirect_url=credential.redirect_url,
refresh_token=credential.refresh_token,
)
oauth2credential = OAuth2Credential.make_from_response(
response=response,
grant_type=credential.grant_type,
client_id=credential.client_id,
client_secret=credential.client_secret,
redirect_url=credential.redirect_url,
)
return Session(oauth2credential=oauth2credential)
elif credential.grant_type == auth.CLIENT_CREDENTIALS_GRANT:
response = _request_access_token(
grant_type=auth.CLIENT_CREDENTIALS_GRANT,
client_id=credential.client_id,
client_secret=credential.client_secret,
scopes=credential.scopes,
)
oauth2credential = OAuth2Credential.make_from_response(
response=response,
grant_type=credential.grant_type,
client_id=credential.client_id,
client_secret=credential.client_secret,
)
return Session(oauth2credential=oauth2credential)
message = '{} Grant Type does not support Refresh Tokens.'
message = message.format(credential.grant_type)
raise UberIllegalState(message) | [
"def",
"refresh_access_token",
"(",
"credential",
")",
":",
"if",
"credential",
".",
"grant_type",
"==",
"auth",
".",
"AUTHORIZATION_CODE_GRANT",
":",
"response",
"=",
"_request_access_token",
"(",
"grant_type",
"=",
"auth",
".",
"REFRESH_TOKEN",
",",
"client_id",
"=",
"credential",
".",
"client_id",
",",
"client_secret",
"=",
"credential",
".",
"client_secret",
",",
"redirect_url",
"=",
"credential",
".",
"redirect_url",
",",
"refresh_token",
"=",
"credential",
".",
"refresh_token",
",",
")",
"oauth2credential",
"=",
"OAuth2Credential",
".",
"make_from_response",
"(",
"response",
"=",
"response",
",",
"grant_type",
"=",
"credential",
".",
"grant_type",
",",
"client_id",
"=",
"credential",
".",
"client_id",
",",
"client_secret",
"=",
"credential",
".",
"client_secret",
",",
"redirect_url",
"=",
"credential",
".",
"redirect_url",
",",
")",
"return",
"Session",
"(",
"oauth2credential",
"=",
"oauth2credential",
")",
"elif",
"credential",
".",
"grant_type",
"==",
"auth",
".",
"CLIENT_CREDENTIALS_GRANT",
":",
"response",
"=",
"_request_access_token",
"(",
"grant_type",
"=",
"auth",
".",
"CLIENT_CREDENTIALS_GRANT",
",",
"client_id",
"=",
"credential",
".",
"client_id",
",",
"client_secret",
"=",
"credential",
".",
"client_secret",
",",
"scopes",
"=",
"credential",
".",
"scopes",
",",
")",
"oauth2credential",
"=",
"OAuth2Credential",
".",
"make_from_response",
"(",
"response",
"=",
"response",
",",
"grant_type",
"=",
"credential",
".",
"grant_type",
",",
"client_id",
"=",
"credential",
".",
"client_id",
",",
"client_secret",
"=",
"credential",
".",
"client_secret",
",",
")",
"return",
"Session",
"(",
"oauth2credential",
"=",
"oauth2credential",
")",
"message",
"=",
"'{} Grant Type does not support Refresh Tokens.'",
"message",
"=",
"message",
".",
"format",
"(",
"credential",
".",
"grant_type",
")",
"raise",
"UberIllegalState",
"(",
"message",
")"
] | Use a refresh token to request a new access token.
Not suported for access tokens obtained via Implicit Grant.
Parameters
credential (OAuth2Credential)
An authorized user's OAuth 2.0 credentials.
Returns
(Session)
A new Session object with refreshed OAuth 2.0 credentials.
Raises
UberIllegalState (APIError)
Raised if OAuth 2.0 grant type does not support
refresh tokens. | [
"Use",
"a",
"refresh",
"token",
"to",
"request",
"a",
"new",
"access",
"token",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/auth.py#L512-L568 | train |
uber/rides-python-sdk | uber_rides/auth.py | OAuth2._build_authorization_request_url | def _build_authorization_request_url(
self,
response_type,
redirect_url,
state=None
):
"""Form URL to request an auth code or access token.
Parameters
response_type (str)
Either 'code' (Authorization Code Grant) or
'token' (Implicit Grant)
redirect_url (str)
The URL that the Uber server will redirect the user to after
finishing authorization. The redirect must be HTTPS-based and
match the URL you registered your application with. Localhost
URLs are permitted and can be either HTTP or HTTPS.
state (str)
Optional CSRF State token to send to server.
Returns
(str)
The fully constructed authorization request URL.
Raises
UberIllegalState (ApiError)
Raised if response_type parameter is invalid.
"""
if response_type not in auth.VALID_RESPONSE_TYPES:
message = '{} is not a valid response type.'
raise UberIllegalState(message.format(response_type))
args = OrderedDict([
('scope', ' '.join(self.scopes)),
('state', state),
('redirect_uri', redirect_url),
('response_type', response_type),
('client_id', self.client_id),
])
return build_url(auth.AUTH_HOST, auth.AUTHORIZE_PATH, args) | python | def _build_authorization_request_url(
self,
response_type,
redirect_url,
state=None
):
"""Form URL to request an auth code or access token.
Parameters
response_type (str)
Either 'code' (Authorization Code Grant) or
'token' (Implicit Grant)
redirect_url (str)
The URL that the Uber server will redirect the user to after
finishing authorization. The redirect must be HTTPS-based and
match the URL you registered your application with. Localhost
URLs are permitted and can be either HTTP or HTTPS.
state (str)
Optional CSRF State token to send to server.
Returns
(str)
The fully constructed authorization request URL.
Raises
UberIllegalState (ApiError)
Raised if response_type parameter is invalid.
"""
if response_type not in auth.VALID_RESPONSE_TYPES:
message = '{} is not a valid response type.'
raise UberIllegalState(message.format(response_type))
args = OrderedDict([
('scope', ' '.join(self.scopes)),
('state', state),
('redirect_uri', redirect_url),
('response_type', response_type),
('client_id', self.client_id),
])
return build_url(auth.AUTH_HOST, auth.AUTHORIZE_PATH, args) | [
"def",
"_build_authorization_request_url",
"(",
"self",
",",
"response_type",
",",
"redirect_url",
",",
"state",
"=",
"None",
")",
":",
"if",
"response_type",
"not",
"in",
"auth",
".",
"VALID_RESPONSE_TYPES",
":",
"message",
"=",
"'{} is not a valid response type.'",
"raise",
"UberIllegalState",
"(",
"message",
".",
"format",
"(",
"response_type",
")",
")",
"args",
"=",
"OrderedDict",
"(",
"[",
"(",
"'scope'",
",",
"' '",
".",
"join",
"(",
"self",
".",
"scopes",
")",
")",
",",
"(",
"'state'",
",",
"state",
")",
",",
"(",
"'redirect_uri'",
",",
"redirect_url",
")",
",",
"(",
"'response_type'",
",",
"response_type",
")",
",",
"(",
"'client_id'",
",",
"self",
".",
"client_id",
")",
",",
"]",
")",
"return",
"build_url",
"(",
"auth",
".",
"AUTH_HOST",
",",
"auth",
".",
"AUTHORIZE_PATH",
",",
"args",
")"
] | Form URL to request an auth code or access token.
Parameters
response_type (str)
Either 'code' (Authorization Code Grant) or
'token' (Implicit Grant)
redirect_url (str)
The URL that the Uber server will redirect the user to after
finishing authorization. The redirect must be HTTPS-based and
match the URL you registered your application with. Localhost
URLs are permitted and can be either HTTP or HTTPS.
state (str)
Optional CSRF State token to send to server.
Returns
(str)
The fully constructed authorization request URL.
Raises
UberIllegalState (ApiError)
Raised if response_type parameter is invalid. | [
"Form",
"URL",
"to",
"request",
"an",
"auth",
"code",
"or",
"access",
"token",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/auth.py#L78-L118 | train |
uber/rides-python-sdk | uber_rides/auth.py | OAuth2._extract_query | def _extract_query(self, redirect_url):
"""Extract query parameters from a url.
Parameters
redirect_url (str)
The full URL that the Uber server redirected to after
the user authorized your app.
Returns
(dict)
A dictionary of query parameters.
"""
qs = urlparse(redirect_url)
# Implicit Grant redirect_urls have data after fragment identifier (#)
# All other redirect_urls return data after query identifier (?)
qs = qs.fragment if isinstance(self, ImplicitGrant) else qs.query
query_params = parse_qs(qs)
query_params = {qp: query_params[qp][0] for qp in query_params}
return query_params | python | def _extract_query(self, redirect_url):
"""Extract query parameters from a url.
Parameters
redirect_url (str)
The full URL that the Uber server redirected to after
the user authorized your app.
Returns
(dict)
A dictionary of query parameters.
"""
qs = urlparse(redirect_url)
# Implicit Grant redirect_urls have data after fragment identifier (#)
# All other redirect_urls return data after query identifier (?)
qs = qs.fragment if isinstance(self, ImplicitGrant) else qs.query
query_params = parse_qs(qs)
query_params = {qp: query_params[qp][0] for qp in query_params}
return query_params | [
"def",
"_extract_query",
"(",
"self",
",",
"redirect_url",
")",
":",
"qs",
"=",
"urlparse",
"(",
"redirect_url",
")",
"# Implicit Grant redirect_urls have data after fragment identifier (#)",
"# All other redirect_urls return data after query identifier (?)",
"qs",
"=",
"qs",
".",
"fragment",
"if",
"isinstance",
"(",
"self",
",",
"ImplicitGrant",
")",
"else",
"qs",
".",
"query",
"query_params",
"=",
"parse_qs",
"(",
"qs",
")",
"query_params",
"=",
"{",
"qp",
":",
"query_params",
"[",
"qp",
"]",
"[",
"0",
"]",
"for",
"qp",
"in",
"query_params",
"}",
"return",
"query_params"
] | Extract query parameters from a url.
Parameters
redirect_url (str)
The full URL that the Uber server redirected to after
the user authorized your app.
Returns
(dict)
A dictionary of query parameters. | [
"Extract",
"query",
"parameters",
"from",
"a",
"url",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/auth.py#L120-L141 | train |
uber/rides-python-sdk | uber_rides/auth.py | AuthorizationCodeGrant._generate_state_token | def _generate_state_token(self, length=32):
"""Generate CSRF State Token.
CSRF State Tokens are passed as a parameter in the authorization
URL and are checked when receiving responses from the Uber Auth
server to prevent request forgery.
"""
choices = ascii_letters + digits
return ''.join(SystemRandom().choice(choices) for _ in range(length)) | python | def _generate_state_token(self, length=32):
"""Generate CSRF State Token.
CSRF State Tokens are passed as a parameter in the authorization
URL and are checked when receiving responses from the Uber Auth
server to prevent request forgery.
"""
choices = ascii_letters + digits
return ''.join(SystemRandom().choice(choices) for _ in range(length)) | [
"def",
"_generate_state_token",
"(",
"self",
",",
"length",
"=",
"32",
")",
":",
"choices",
"=",
"ascii_letters",
"+",
"digits",
"return",
"''",
".",
"join",
"(",
"SystemRandom",
"(",
")",
".",
"choice",
"(",
"choices",
")",
"for",
"_",
"in",
"range",
"(",
"length",
")",
")"
] | Generate CSRF State Token.
CSRF State Tokens are passed as a parameter in the authorization
URL and are checked when receiving responses from the Uber Auth
server to prevent request forgery. | [
"Generate",
"CSRF",
"State",
"Token",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/auth.py#L194-L202 | train |
uber/rides-python-sdk | uber_rides/auth.py | AuthorizationCodeGrant.get_authorization_url | def get_authorization_url(self):
"""Start the Authorization Code Grant process.
This function starts the OAuth 2.0 authorization process and builds an
authorization URL. You should redirect your user to this URL, where
they can grant your application access to their Uber account.
Returns
(str)
The fully constructed authorization request URL.
Tell the user to visit this URL and approve your app.
"""
return self._build_authorization_request_url(
response_type=auth.CODE_RESPONSE_TYPE,
redirect_url=self.redirect_url,
state=self.state_token,
) | python | def get_authorization_url(self):
"""Start the Authorization Code Grant process.
This function starts the OAuth 2.0 authorization process and builds an
authorization URL. You should redirect your user to this URL, where
they can grant your application access to their Uber account.
Returns
(str)
The fully constructed authorization request URL.
Tell the user to visit this URL and approve your app.
"""
return self._build_authorization_request_url(
response_type=auth.CODE_RESPONSE_TYPE,
redirect_url=self.redirect_url,
state=self.state_token,
) | [
"def",
"get_authorization_url",
"(",
"self",
")",
":",
"return",
"self",
".",
"_build_authorization_request_url",
"(",
"response_type",
"=",
"auth",
".",
"CODE_RESPONSE_TYPE",
",",
"redirect_url",
"=",
"self",
".",
"redirect_url",
",",
"state",
"=",
"self",
".",
"state_token",
",",
")"
] | Start the Authorization Code Grant process.
This function starts the OAuth 2.0 authorization process and builds an
authorization URL. You should redirect your user to this URL, where
they can grant your application access to their Uber account.
Returns
(str)
The fully constructed authorization request URL.
Tell the user to visit this URL and approve your app. | [
"Start",
"the",
"Authorization",
"Code",
"Grant",
"process",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/auth.py#L204-L220 | train |
uber/rides-python-sdk | uber_rides/auth.py | AuthorizationCodeGrant._verify_query | def _verify_query(self, query_params):
"""Verify response from the Uber Auth server.
Parameters
query_params (dict)
Dictionary of query parameters attached to your redirect URL
after user approved your app and was redirected.
Returns
authorization_code (str)
Code received when user grants your app access. Use this code
to request an access token.
Raises
UberIllegalState (ApiError)
Thrown if the redirect URL was missing parameters or if the
given parameters were not valid.
"""
error_message = None
if self.state_token is not False:
# Check CSRF State Token against state token from GET request
received_state_token = query_params.get('state')
if received_state_token is None:
error_message = 'Bad Request. Missing state parameter.'
raise UberIllegalState(error_message)
if self.state_token != received_state_token:
error_message = 'CSRF Error. Expected {}, got {}'
error_message = error_message.format(
self.state_token,
received_state_token,
)
raise UberIllegalState(error_message)
# Verify either 'code' or 'error' parameter exists
error = query_params.get('error')
authorization_code = query_params.get(auth.CODE_RESPONSE_TYPE)
if error and authorization_code:
error_message = (
'Code and Error query params code and error '
'can not both be set.'
)
raise UberIllegalState(error_message)
if error is None and authorization_code is None:
error_message = 'Neither query parameter code or error is set.'
raise UberIllegalState(error_message)
if error:
raise UberIllegalState(error)
return authorization_code | python | def _verify_query(self, query_params):
"""Verify response from the Uber Auth server.
Parameters
query_params (dict)
Dictionary of query parameters attached to your redirect URL
after user approved your app and was redirected.
Returns
authorization_code (str)
Code received when user grants your app access. Use this code
to request an access token.
Raises
UberIllegalState (ApiError)
Thrown if the redirect URL was missing parameters or if the
given parameters were not valid.
"""
error_message = None
if self.state_token is not False:
# Check CSRF State Token against state token from GET request
received_state_token = query_params.get('state')
if received_state_token is None:
error_message = 'Bad Request. Missing state parameter.'
raise UberIllegalState(error_message)
if self.state_token != received_state_token:
error_message = 'CSRF Error. Expected {}, got {}'
error_message = error_message.format(
self.state_token,
received_state_token,
)
raise UberIllegalState(error_message)
# Verify either 'code' or 'error' parameter exists
error = query_params.get('error')
authorization_code = query_params.get(auth.CODE_RESPONSE_TYPE)
if error and authorization_code:
error_message = (
'Code and Error query params code and error '
'can not both be set.'
)
raise UberIllegalState(error_message)
if error is None and authorization_code is None:
error_message = 'Neither query parameter code or error is set.'
raise UberIllegalState(error_message)
if error:
raise UberIllegalState(error)
return authorization_code | [
"def",
"_verify_query",
"(",
"self",
",",
"query_params",
")",
":",
"error_message",
"=",
"None",
"if",
"self",
".",
"state_token",
"is",
"not",
"False",
":",
"# Check CSRF State Token against state token from GET request",
"received_state_token",
"=",
"query_params",
".",
"get",
"(",
"'state'",
")",
"if",
"received_state_token",
"is",
"None",
":",
"error_message",
"=",
"'Bad Request. Missing state parameter.'",
"raise",
"UberIllegalState",
"(",
"error_message",
")",
"if",
"self",
".",
"state_token",
"!=",
"received_state_token",
":",
"error_message",
"=",
"'CSRF Error. Expected {}, got {}'",
"error_message",
"=",
"error_message",
".",
"format",
"(",
"self",
".",
"state_token",
",",
"received_state_token",
",",
")",
"raise",
"UberIllegalState",
"(",
"error_message",
")",
"# Verify either 'code' or 'error' parameter exists",
"error",
"=",
"query_params",
".",
"get",
"(",
"'error'",
")",
"authorization_code",
"=",
"query_params",
".",
"get",
"(",
"auth",
".",
"CODE_RESPONSE_TYPE",
")",
"if",
"error",
"and",
"authorization_code",
":",
"error_message",
"=",
"(",
"'Code and Error query params code and error '",
"'can not both be set.'",
")",
"raise",
"UberIllegalState",
"(",
"error_message",
")",
"if",
"error",
"is",
"None",
"and",
"authorization_code",
"is",
"None",
":",
"error_message",
"=",
"'Neither query parameter code or error is set.'",
"raise",
"UberIllegalState",
"(",
"error_message",
")",
"if",
"error",
":",
"raise",
"UberIllegalState",
"(",
"error",
")",
"return",
"authorization_code"
] | Verify response from the Uber Auth server.
Parameters
query_params (dict)
Dictionary of query parameters attached to your redirect URL
after user approved your app and was redirected.
Returns
authorization_code (str)
Code received when user grants your app access. Use this code
to request an access token.
Raises
UberIllegalState (ApiError)
Thrown if the redirect URL was missing parameters or if the
given parameters were not valid. | [
"Verify",
"response",
"from",
"the",
"Uber",
"Auth",
"server",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/auth.py#L222-L275 | train |
uber/rides-python-sdk | uber_rides/auth.py | ImplicitGrant.get_authorization_url | def get_authorization_url(self):
"""Build URL for authorization request.
Returns
(str)
The fully constructed authorization request URL.
"""
return self._build_authorization_request_url(
response_type=auth.TOKEN_RESPONSE_TYPE,
redirect_url=self.redirect_url,
) | python | def get_authorization_url(self):
"""Build URL for authorization request.
Returns
(str)
The fully constructed authorization request URL.
"""
return self._build_authorization_request_url(
response_type=auth.TOKEN_RESPONSE_TYPE,
redirect_url=self.redirect_url,
) | [
"def",
"get_authorization_url",
"(",
"self",
")",
":",
"return",
"self",
".",
"_build_authorization_request_url",
"(",
"response_type",
"=",
"auth",
".",
"TOKEN_RESPONSE_TYPE",
",",
"redirect_url",
"=",
"self",
".",
"redirect_url",
",",
")"
] | Build URL for authorization request.
Returns
(str)
The fully constructed authorization request URL. | [
"Build",
"URL",
"for",
"authorization",
"request",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/auth.py#L346-L356 | train |
uber/rides-python-sdk | uber_rides/client.py | surge_handler | def surge_handler(response, **kwargs):
"""Error Handler to surface 409 Surge Conflict errors.
Attached as a callback hook on the Request object.
Parameters
response (requests.Response)
The HTTP response from an API request.
**kwargs
Arbitrary keyword arguments.
"""
if response.status_code == codes.conflict:
json = response.json()
errors = json.get('errors', [])
error = errors[0] if errors else json.get('error')
if error and error.get('code') == 'surge':
raise SurgeError(response)
return response | python | def surge_handler(response, **kwargs):
"""Error Handler to surface 409 Surge Conflict errors.
Attached as a callback hook on the Request object.
Parameters
response (requests.Response)
The HTTP response from an API request.
**kwargs
Arbitrary keyword arguments.
"""
if response.status_code == codes.conflict:
json = response.json()
errors = json.get('errors', [])
error = errors[0] if errors else json.get('error')
if error and error.get('code') == 'surge':
raise SurgeError(response)
return response | [
"def",
"surge_handler",
"(",
"response",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"response",
".",
"status_code",
"==",
"codes",
".",
"conflict",
":",
"json",
"=",
"response",
".",
"json",
"(",
")",
"errors",
"=",
"json",
".",
"get",
"(",
"'errors'",
",",
"[",
"]",
")",
"error",
"=",
"errors",
"[",
"0",
"]",
"if",
"errors",
"else",
"json",
".",
"get",
"(",
"'error'",
")",
"if",
"error",
"and",
"error",
".",
"get",
"(",
"'code'",
")",
"==",
"'surge'",
":",
"raise",
"SurgeError",
"(",
"response",
")",
"return",
"response"
] | Error Handler to surface 409 Surge Conflict errors.
Attached as a callback hook on the Request object.
Parameters
response (requests.Response)
The HTTP response from an API request.
**kwargs
Arbitrary keyword arguments. | [
"Error",
"Handler",
"to",
"surface",
"409",
"Surge",
"Conflict",
"errors",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L879-L898 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.get_products | def get_products(self, latitude, longitude):
"""Get information about the Uber products offered at a given location.
Parameters
latitude (float)
The latitude component of a location.
longitude (float)
The longitude component of a location.
Returns
(Response)
A Response object containing available products information.
"""
args = OrderedDict([
('latitude', latitude),
('longitude', longitude),
])
return self._api_call('GET', 'v1.2/products', args=args) | python | def get_products(self, latitude, longitude):
"""Get information about the Uber products offered at a given location.
Parameters
latitude (float)
The latitude component of a location.
longitude (float)
The longitude component of a location.
Returns
(Response)
A Response object containing available products information.
"""
args = OrderedDict([
('latitude', latitude),
('longitude', longitude),
])
return self._api_call('GET', 'v1.2/products', args=args) | [
"def",
"get_products",
"(",
"self",
",",
"latitude",
",",
"longitude",
")",
":",
"args",
"=",
"OrderedDict",
"(",
"[",
"(",
"'latitude'",
",",
"latitude",
")",
",",
"(",
"'longitude'",
",",
"longitude",
")",
",",
"]",
")",
"return",
"self",
".",
"_api_call",
"(",
"'GET'",
",",
"'v1.2/products'",
",",
"args",
"=",
"args",
")"
] | Get information about the Uber products offered at a given location.
Parameters
latitude (float)
The latitude component of a location.
longitude (float)
The longitude component of a location.
Returns
(Response)
A Response object containing available products information. | [
"Get",
"information",
"about",
"the",
"Uber",
"products",
"offered",
"at",
"a",
"given",
"location",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L109-L127 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.get_price_estimates | def get_price_estimates(
self,
start_latitude,
start_longitude,
end_latitude,
end_longitude,
seat_count=None,
):
"""Get price estimates for products at a given location.
Parameters
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
end_latitude (float)
The latitude component of a end location.
end_longitude (float)
The longitude component of a end location.
seat_count (int)
The number of seats required for uberPOOL.
Default and maximum value is 2.
Returns
(Response)
A Response object containing each product's price estimates.
"""
args = OrderedDict([
('start_latitude', start_latitude),
('start_longitude', start_longitude),
('end_latitude', end_latitude),
('end_longitude', end_longitude),
('seat_count', seat_count),
])
return self._api_call('GET', 'v1.2/estimates/price', args=args) | python | def get_price_estimates(
self,
start_latitude,
start_longitude,
end_latitude,
end_longitude,
seat_count=None,
):
"""Get price estimates for products at a given location.
Parameters
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
end_latitude (float)
The latitude component of a end location.
end_longitude (float)
The longitude component of a end location.
seat_count (int)
The number of seats required for uberPOOL.
Default and maximum value is 2.
Returns
(Response)
A Response object containing each product's price estimates.
"""
args = OrderedDict([
('start_latitude', start_latitude),
('start_longitude', start_longitude),
('end_latitude', end_latitude),
('end_longitude', end_longitude),
('seat_count', seat_count),
])
return self._api_call('GET', 'v1.2/estimates/price', args=args) | [
"def",
"get_price_estimates",
"(",
"self",
",",
"start_latitude",
",",
"start_longitude",
",",
"end_latitude",
",",
"end_longitude",
",",
"seat_count",
"=",
"None",
",",
")",
":",
"args",
"=",
"OrderedDict",
"(",
"[",
"(",
"'start_latitude'",
",",
"start_latitude",
")",
",",
"(",
"'start_longitude'",
",",
"start_longitude",
")",
",",
"(",
"'end_latitude'",
",",
"end_latitude",
")",
",",
"(",
"'end_longitude'",
",",
"end_longitude",
")",
",",
"(",
"'seat_count'",
",",
"seat_count",
")",
",",
"]",
")",
"return",
"self",
".",
"_api_call",
"(",
"'GET'",
",",
"'v1.2/estimates/price'",
",",
"args",
"=",
"args",
")"
] | Get price estimates for products at a given location.
Parameters
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
end_latitude (float)
The latitude component of a end location.
end_longitude (float)
The longitude component of a end location.
seat_count (int)
The number of seats required for uberPOOL.
Default and maximum value is 2.
Returns
(Response)
A Response object containing each product's price estimates. | [
"Get",
"price",
"estimates",
"for",
"products",
"at",
"a",
"given",
"location",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L144-L179 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.get_pickup_time_estimates | def get_pickup_time_estimates(
self,
start_latitude,
start_longitude,
product_id=None,
):
"""Get pickup time estimates for products at a given location.
Parameters
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
product_id (str)
The unique ID of the product being requested. If none is
provided, it will default to the cheapest product for the
given location.
Returns
(Response)
A Response containing each product's pickup time estimates.
"""
args = OrderedDict([
('start_latitude', start_latitude),
('start_longitude', start_longitude),
('product_id', product_id),
])
return self._api_call('GET', 'v1.2/estimates/time', args=args) | python | def get_pickup_time_estimates(
self,
start_latitude,
start_longitude,
product_id=None,
):
"""Get pickup time estimates for products at a given location.
Parameters
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
product_id (str)
The unique ID of the product being requested. If none is
provided, it will default to the cheapest product for the
given location.
Returns
(Response)
A Response containing each product's pickup time estimates.
"""
args = OrderedDict([
('start_latitude', start_latitude),
('start_longitude', start_longitude),
('product_id', product_id),
])
return self._api_call('GET', 'v1.2/estimates/time', args=args) | [
"def",
"get_pickup_time_estimates",
"(",
"self",
",",
"start_latitude",
",",
"start_longitude",
",",
"product_id",
"=",
"None",
",",
")",
":",
"args",
"=",
"OrderedDict",
"(",
"[",
"(",
"'start_latitude'",
",",
"start_latitude",
")",
",",
"(",
"'start_longitude'",
",",
"start_longitude",
")",
",",
"(",
"'product_id'",
",",
"product_id",
")",
",",
"]",
")",
"return",
"self",
".",
"_api_call",
"(",
"'GET'",
",",
"'v1.2/estimates/time'",
",",
"args",
"=",
"args",
")"
] | Get pickup time estimates for products at a given location.
Parameters
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
product_id (str)
The unique ID of the product being requested. If none is
provided, it will default to the cheapest product for the
given location.
Returns
(Response)
A Response containing each product's pickup time estimates. | [
"Get",
"pickup",
"time",
"estimates",
"for",
"products",
"at",
"a",
"given",
"location",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L181-L209 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.get_promotions | def get_promotions(
self,
start_latitude,
start_longitude,
end_latitude,
end_longitude,
):
"""Get information about the promotions available to a user.
Parameters
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
end_latitude (float)
The latitude component of a end location.
end_longitude (float)
The longitude component of a end location.
Returns
(Response)
A Response object containing available promotions.
"""
args = OrderedDict([
('start_latitude', start_latitude),
('start_longitude', start_longitude),
('end_latitude', end_latitude),
('end_longitude', end_longitude)
])
return self._api_call('GET', 'v1.2/promotions', args=args) | python | def get_promotions(
self,
start_latitude,
start_longitude,
end_latitude,
end_longitude,
):
"""Get information about the promotions available to a user.
Parameters
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
end_latitude (float)
The latitude component of a end location.
end_longitude (float)
The longitude component of a end location.
Returns
(Response)
A Response object containing available promotions.
"""
args = OrderedDict([
('start_latitude', start_latitude),
('start_longitude', start_longitude),
('end_latitude', end_latitude),
('end_longitude', end_longitude)
])
return self._api_call('GET', 'v1.2/promotions', args=args) | [
"def",
"get_promotions",
"(",
"self",
",",
"start_latitude",
",",
"start_longitude",
",",
"end_latitude",
",",
"end_longitude",
",",
")",
":",
"args",
"=",
"OrderedDict",
"(",
"[",
"(",
"'start_latitude'",
",",
"start_latitude",
")",
",",
"(",
"'start_longitude'",
",",
"start_longitude",
")",
",",
"(",
"'end_latitude'",
",",
"end_latitude",
")",
",",
"(",
"'end_longitude'",
",",
"end_longitude",
")",
"]",
")",
"return",
"self",
".",
"_api_call",
"(",
"'GET'",
",",
"'v1.2/promotions'",
",",
"args",
"=",
"args",
")"
] | Get information about the promotions available to a user.
Parameters
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
end_latitude (float)
The latitude component of a end location.
end_longitude (float)
The longitude component of a end location.
Returns
(Response)
A Response object containing available promotions. | [
"Get",
"information",
"about",
"the",
"promotions",
"available",
"to",
"a",
"user",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L211-L242 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.get_user_activity | def get_user_activity(self, offset=None, limit=None):
"""Get activity about the user's lifetime activity with Uber.
Parameters
offset (int)
The integer offset for activity results. Default is 0.
limit (int)
Integer amount of results to return. Maximum is 50.
Default is 5.
Returns
(Response)
A Response object containing ride history.
"""
args = {
'offset': offset,
'limit': limit,
}
return self._api_call('GET', 'v1.2/history', args=args) | python | def get_user_activity(self, offset=None, limit=None):
"""Get activity about the user's lifetime activity with Uber.
Parameters
offset (int)
The integer offset for activity results. Default is 0.
limit (int)
Integer amount of results to return. Maximum is 50.
Default is 5.
Returns
(Response)
A Response object containing ride history.
"""
args = {
'offset': offset,
'limit': limit,
}
return self._api_call('GET', 'v1.2/history', args=args) | [
"def",
"get_user_activity",
"(",
"self",
",",
"offset",
"=",
"None",
",",
"limit",
"=",
"None",
")",
":",
"args",
"=",
"{",
"'offset'",
":",
"offset",
",",
"'limit'",
":",
"limit",
",",
"}",
"return",
"self",
".",
"_api_call",
"(",
"'GET'",
",",
"'v1.2/history'",
",",
"args",
"=",
"args",
")"
] | Get activity about the user's lifetime activity with Uber.
Parameters
offset (int)
The integer offset for activity results. Default is 0.
limit (int)
Integer amount of results to return. Maximum is 50.
Default is 5.
Returns
(Response)
A Response object containing ride history. | [
"Get",
"activity",
"about",
"the",
"user",
"s",
"lifetime",
"activity",
"with",
"Uber",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L244-L263 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.estimate_ride | def estimate_ride(
self,
product_id=None,
start_latitude=None,
start_longitude=None,
start_place_id=None,
end_latitude=None,
end_longitude=None,
end_place_id=None,
seat_count=None,
):
"""Estimate ride details given a product, start, and end location.
Only pickup time estimates and surge pricing information are provided
if no end location is provided.
Parameters
product_id (str)
The unique ID of the product being requested. If none is
provided, it will default to the cheapest product for the
given location.
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
start_place_id (str)
The beginning or pickup place ID. Only "home" or "work"
is acceptable.
end_latitude (float)
Optional latitude component of a end location.
end_longitude (float)
Optional longitude component of a end location.
end_place_id (str)
The final or destination place ID. Only "home" or "work"
is acceptable.
seat_count (str)
Optional Seat count for shared products. Default is 2.
Returns
(Response)
A Response object containing fare id, time, price, and distance
estimates for a ride.
"""
args = {
'product_id': product_id,
'start_latitude': start_latitude,
'start_longitude': start_longitude,
'start_place_id': start_place_id,
'end_latitude': end_latitude,
'end_longitude': end_longitude,
'end_place_id': end_place_id,
'seat_count': seat_count
}
return self._api_call('POST', 'v1.2/requests/estimate', args=args) | python | def estimate_ride(
self,
product_id=None,
start_latitude=None,
start_longitude=None,
start_place_id=None,
end_latitude=None,
end_longitude=None,
end_place_id=None,
seat_count=None,
):
"""Estimate ride details given a product, start, and end location.
Only pickup time estimates and surge pricing information are provided
if no end location is provided.
Parameters
product_id (str)
The unique ID of the product being requested. If none is
provided, it will default to the cheapest product for the
given location.
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
start_place_id (str)
The beginning or pickup place ID. Only "home" or "work"
is acceptable.
end_latitude (float)
Optional latitude component of a end location.
end_longitude (float)
Optional longitude component of a end location.
end_place_id (str)
The final or destination place ID. Only "home" or "work"
is acceptable.
seat_count (str)
Optional Seat count for shared products. Default is 2.
Returns
(Response)
A Response object containing fare id, time, price, and distance
estimates for a ride.
"""
args = {
'product_id': product_id,
'start_latitude': start_latitude,
'start_longitude': start_longitude,
'start_place_id': start_place_id,
'end_latitude': end_latitude,
'end_longitude': end_longitude,
'end_place_id': end_place_id,
'seat_count': seat_count
}
return self._api_call('POST', 'v1.2/requests/estimate', args=args) | [
"def",
"estimate_ride",
"(",
"self",
",",
"product_id",
"=",
"None",
",",
"start_latitude",
"=",
"None",
",",
"start_longitude",
"=",
"None",
",",
"start_place_id",
"=",
"None",
",",
"end_latitude",
"=",
"None",
",",
"end_longitude",
"=",
"None",
",",
"end_place_id",
"=",
"None",
",",
"seat_count",
"=",
"None",
",",
")",
":",
"args",
"=",
"{",
"'product_id'",
":",
"product_id",
",",
"'start_latitude'",
":",
"start_latitude",
",",
"'start_longitude'",
":",
"start_longitude",
",",
"'start_place_id'",
":",
"start_place_id",
",",
"'end_latitude'",
":",
"end_latitude",
",",
"'end_longitude'",
":",
"end_longitude",
",",
"'end_place_id'",
":",
"end_place_id",
",",
"'seat_count'",
":",
"seat_count",
"}",
"return",
"self",
".",
"_api_call",
"(",
"'POST'",
",",
"'v1.2/requests/estimate'",
",",
"args",
"=",
"args",
")"
] | Estimate ride details given a product, start, and end location.
Only pickup time estimates and surge pricing information are provided
if no end location is provided.
Parameters
product_id (str)
The unique ID of the product being requested. If none is
provided, it will default to the cheapest product for the
given location.
start_latitude (float)
The latitude component of a start location.
start_longitude (float)
The longitude component of a start location.
start_place_id (str)
The beginning or pickup place ID. Only "home" or "work"
is acceptable.
end_latitude (float)
Optional latitude component of a end location.
end_longitude (float)
Optional longitude component of a end location.
end_place_id (str)
The final or destination place ID. Only "home" or "work"
is acceptable.
seat_count (str)
Optional Seat count for shared products. Default is 2.
Returns
(Response)
A Response object containing fare id, time, price, and distance
estimates for a ride. | [
"Estimate",
"ride",
"details",
"given",
"a",
"product",
"start",
"and",
"end",
"location",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L319-L374 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.request_ride | def request_ride(
self,
product_id=None,
start_latitude=None,
start_longitude=None,
start_place_id=None,
start_address=None,
start_nickname=None,
end_latitude=None,
end_longitude=None,
end_place_id=None,
end_address=None,
end_nickname=None,
seat_count=None,
fare_id=None,
surge_confirmation_id=None,
payment_method_id=None,
):
"""Request a ride on behalf of an Uber user.
When specifying pickup and dropoff locations, you can either use
latitude/longitude pairs or place ID (but not both).
Parameters
product_id (str)
The unique ID of the product being requested. If none is
provided, it will default to the cheapest product for the
given location.
start_latitude (float)
Optional latitude component of a start location.
start_longitude (float)
Optional longitude component of a start location.
start_place_id (str)
The beginning or pickup place ID. Only "home" or "work"
is acceptable.
start_address (str)
Optional pickup address.
start_nickname (str)
Optional pickup nickname label.
end_latitude (float)
Optional latitude component of a end location.
end_longitude (float)
Optional longitude component of a end location.
end_place_id (str)
The final or destination place ID. Only "home" or "work"
is acceptable.
end_address (str)
Optional destination address.
end_nickname (str)
Optional destination nickname label.
seat_count (int)
Optional seat count for shared products.
fare_id (str)
Optional fare_id for shared products.
surge_confirmation_id (str)
Optional unique identifier of the surge session for a user.
payment_method_id (str)
Optional unique identifier of the payment method selected
by a user. If set, the trip will be requested using this
payment method. If not, the trip will be requested with the
user's last used payment method.
Returns
(Response)
A Response object containing the ride request ID and other
details about the requested ride.
Raises
SurgeError (ClientError)
Thrown when the requested product is currently surging.
User must confirm surge price through surge_confirmation_href.
"""
args = {
'product_id': product_id,
'start_latitude': start_latitude,
'start_longitude': start_longitude,
'start_place_id': start_place_id,
'start_address': start_address,
'start_nickname': start_nickname,
'end_latitude': end_latitude,
'end_longitude': end_longitude,
'end_place_id': end_place_id,
'end_address': end_address,
'end_nickname': end_nickname,
'surge_confirmation_id': surge_confirmation_id,
'payment_method_id': payment_method_id,
'seat_count': seat_count,
'fare_id': fare_id
}
return self._api_call('POST', 'v1.2/requests', args=args) | python | def request_ride(
self,
product_id=None,
start_latitude=None,
start_longitude=None,
start_place_id=None,
start_address=None,
start_nickname=None,
end_latitude=None,
end_longitude=None,
end_place_id=None,
end_address=None,
end_nickname=None,
seat_count=None,
fare_id=None,
surge_confirmation_id=None,
payment_method_id=None,
):
"""Request a ride on behalf of an Uber user.
When specifying pickup and dropoff locations, you can either use
latitude/longitude pairs or place ID (but not both).
Parameters
product_id (str)
The unique ID of the product being requested. If none is
provided, it will default to the cheapest product for the
given location.
start_latitude (float)
Optional latitude component of a start location.
start_longitude (float)
Optional longitude component of a start location.
start_place_id (str)
The beginning or pickup place ID. Only "home" or "work"
is acceptable.
start_address (str)
Optional pickup address.
start_nickname (str)
Optional pickup nickname label.
end_latitude (float)
Optional latitude component of a end location.
end_longitude (float)
Optional longitude component of a end location.
end_place_id (str)
The final or destination place ID. Only "home" or "work"
is acceptable.
end_address (str)
Optional destination address.
end_nickname (str)
Optional destination nickname label.
seat_count (int)
Optional seat count for shared products.
fare_id (str)
Optional fare_id for shared products.
surge_confirmation_id (str)
Optional unique identifier of the surge session for a user.
payment_method_id (str)
Optional unique identifier of the payment method selected
by a user. If set, the trip will be requested using this
payment method. If not, the trip will be requested with the
user's last used payment method.
Returns
(Response)
A Response object containing the ride request ID and other
details about the requested ride.
Raises
SurgeError (ClientError)
Thrown when the requested product is currently surging.
User must confirm surge price through surge_confirmation_href.
"""
args = {
'product_id': product_id,
'start_latitude': start_latitude,
'start_longitude': start_longitude,
'start_place_id': start_place_id,
'start_address': start_address,
'start_nickname': start_nickname,
'end_latitude': end_latitude,
'end_longitude': end_longitude,
'end_place_id': end_place_id,
'end_address': end_address,
'end_nickname': end_nickname,
'surge_confirmation_id': surge_confirmation_id,
'payment_method_id': payment_method_id,
'seat_count': seat_count,
'fare_id': fare_id
}
return self._api_call('POST', 'v1.2/requests', args=args) | [
"def",
"request_ride",
"(",
"self",
",",
"product_id",
"=",
"None",
",",
"start_latitude",
"=",
"None",
",",
"start_longitude",
"=",
"None",
",",
"start_place_id",
"=",
"None",
",",
"start_address",
"=",
"None",
",",
"start_nickname",
"=",
"None",
",",
"end_latitude",
"=",
"None",
",",
"end_longitude",
"=",
"None",
",",
"end_place_id",
"=",
"None",
",",
"end_address",
"=",
"None",
",",
"end_nickname",
"=",
"None",
",",
"seat_count",
"=",
"None",
",",
"fare_id",
"=",
"None",
",",
"surge_confirmation_id",
"=",
"None",
",",
"payment_method_id",
"=",
"None",
",",
")",
":",
"args",
"=",
"{",
"'product_id'",
":",
"product_id",
",",
"'start_latitude'",
":",
"start_latitude",
",",
"'start_longitude'",
":",
"start_longitude",
",",
"'start_place_id'",
":",
"start_place_id",
",",
"'start_address'",
":",
"start_address",
",",
"'start_nickname'",
":",
"start_nickname",
",",
"'end_latitude'",
":",
"end_latitude",
",",
"'end_longitude'",
":",
"end_longitude",
",",
"'end_place_id'",
":",
"end_place_id",
",",
"'end_address'",
":",
"end_address",
",",
"'end_nickname'",
":",
"end_nickname",
",",
"'surge_confirmation_id'",
":",
"surge_confirmation_id",
",",
"'payment_method_id'",
":",
"payment_method_id",
",",
"'seat_count'",
":",
"seat_count",
",",
"'fare_id'",
":",
"fare_id",
"}",
"return",
"self",
".",
"_api_call",
"(",
"'POST'",
",",
"'v1.2/requests'",
",",
"args",
"=",
"args",
")"
] | Request a ride on behalf of an Uber user.
When specifying pickup and dropoff locations, you can either use
latitude/longitude pairs or place ID (but not both).
Parameters
product_id (str)
The unique ID of the product being requested. If none is
provided, it will default to the cheapest product for the
given location.
start_latitude (float)
Optional latitude component of a start location.
start_longitude (float)
Optional longitude component of a start location.
start_place_id (str)
The beginning or pickup place ID. Only "home" or "work"
is acceptable.
start_address (str)
Optional pickup address.
start_nickname (str)
Optional pickup nickname label.
end_latitude (float)
Optional latitude component of a end location.
end_longitude (float)
Optional longitude component of a end location.
end_place_id (str)
The final or destination place ID. Only "home" or "work"
is acceptable.
end_address (str)
Optional destination address.
end_nickname (str)
Optional destination nickname label.
seat_count (int)
Optional seat count for shared products.
fare_id (str)
Optional fare_id for shared products.
surge_confirmation_id (str)
Optional unique identifier of the surge session for a user.
payment_method_id (str)
Optional unique identifier of the payment method selected
by a user. If set, the trip will be requested using this
payment method. If not, the trip will be requested with the
user's last used payment method.
Returns
(Response)
A Response object containing the ride request ID and other
details about the requested ride.
Raises
SurgeError (ClientError)
Thrown when the requested product is currently surging.
User must confirm surge price through surge_confirmation_href. | [
"Request",
"a",
"ride",
"on",
"behalf",
"of",
"an",
"Uber",
"user",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L376-L466 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.update_ride | def update_ride(
self,
ride_id,
end_latitude=None,
end_longitude=None,
end_place_id=None,
):
"""Update an ongoing ride's destination.
To specify a new dropoff location, you can either use a
latitude/longitude pair or place ID (but not both).
Params
ride_id (str)
The unique ID of the Ride Request.
end_latitude (float)
The latitude component of a end location.
end_longitude (float)
The longitude component of a end location.
end_place_id (str)
The final or destination place ID. This is the name of an
Uber saved place. Only "home" or "work" is acceptable.
end_address (str)
The final or destination address.
end_nickname (str)
The final or destination nickname label.
Returns
(Response)
The Response with successful status_code
if the ride's destination was updated.
"""
args = {}
if end_latitude is not None:
args.update({'end_latitude': end_latitude})
if end_longitude is not None:
args.update({'end_longitude': end_longitude})
if end_place_id is not None:
args.update({'end_place_id': end_place_id})
endpoint = 'v1.2/requests/{}'.format(ride_id)
return self._api_call('PATCH', endpoint, args=args) | python | def update_ride(
self,
ride_id,
end_latitude=None,
end_longitude=None,
end_place_id=None,
):
"""Update an ongoing ride's destination.
To specify a new dropoff location, you can either use a
latitude/longitude pair or place ID (but not both).
Params
ride_id (str)
The unique ID of the Ride Request.
end_latitude (float)
The latitude component of a end location.
end_longitude (float)
The longitude component of a end location.
end_place_id (str)
The final or destination place ID. This is the name of an
Uber saved place. Only "home" or "work" is acceptable.
end_address (str)
The final or destination address.
end_nickname (str)
The final or destination nickname label.
Returns
(Response)
The Response with successful status_code
if the ride's destination was updated.
"""
args = {}
if end_latitude is not None:
args.update({'end_latitude': end_latitude})
if end_longitude is not None:
args.update({'end_longitude': end_longitude})
if end_place_id is not None:
args.update({'end_place_id': end_place_id})
endpoint = 'v1.2/requests/{}'.format(ride_id)
return self._api_call('PATCH', endpoint, args=args) | [
"def",
"update_ride",
"(",
"self",
",",
"ride_id",
",",
"end_latitude",
"=",
"None",
",",
"end_longitude",
"=",
"None",
",",
"end_place_id",
"=",
"None",
",",
")",
":",
"args",
"=",
"{",
"}",
"if",
"end_latitude",
"is",
"not",
"None",
":",
"args",
".",
"update",
"(",
"{",
"'end_latitude'",
":",
"end_latitude",
"}",
")",
"if",
"end_longitude",
"is",
"not",
"None",
":",
"args",
".",
"update",
"(",
"{",
"'end_longitude'",
":",
"end_longitude",
"}",
")",
"if",
"end_place_id",
"is",
"not",
"None",
":",
"args",
".",
"update",
"(",
"{",
"'end_place_id'",
":",
"end_place_id",
"}",
")",
"endpoint",
"=",
"'v1.2/requests/{}'",
".",
"format",
"(",
"ride_id",
")",
"return",
"self",
".",
"_api_call",
"(",
"'PATCH'",
",",
"endpoint",
",",
"args",
"=",
"args",
")"
] | Update an ongoing ride's destination.
To specify a new dropoff location, you can either use a
latitude/longitude pair or place ID (but not both).
Params
ride_id (str)
The unique ID of the Ride Request.
end_latitude (float)
The latitude component of a end location.
end_longitude (float)
The longitude component of a end location.
end_place_id (str)
The final or destination place ID. This is the name of an
Uber saved place. Only "home" or "work" is acceptable.
end_address (str)
The final or destination address.
end_nickname (str)
The final or destination nickname label.
Returns
(Response)
The Response with successful status_code
if the ride's destination was updated. | [
"Update",
"an",
"ongoing",
"ride",
"s",
"destination",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L498-L539 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.update_sandbox_ride | def update_sandbox_ride(self, ride_id, new_status):
"""Update the status of an ongoing sandbox request.
Params
ride_id (str)
The unique ID of the Ride Request.
new_status (str)
Status from VALID_PRODUCT_STATUS.
Returns
(Response)
A Response object with successful status_code
if ride status was updated.
"""
if new_status not in VALID_PRODUCT_STATUS:
message = '{} is not a valid product status.'
raise UberIllegalState(message.format(new_status))
args = {'status': new_status}
endpoint = 'v1.2/sandbox/requests/{}'.format(ride_id)
return self._api_call('PUT', endpoint, args=args) | python | def update_sandbox_ride(self, ride_id, new_status):
"""Update the status of an ongoing sandbox request.
Params
ride_id (str)
The unique ID of the Ride Request.
new_status (str)
Status from VALID_PRODUCT_STATUS.
Returns
(Response)
A Response object with successful status_code
if ride status was updated.
"""
if new_status not in VALID_PRODUCT_STATUS:
message = '{} is not a valid product status.'
raise UberIllegalState(message.format(new_status))
args = {'status': new_status}
endpoint = 'v1.2/sandbox/requests/{}'.format(ride_id)
return self._api_call('PUT', endpoint, args=args) | [
"def",
"update_sandbox_ride",
"(",
"self",
",",
"ride_id",
",",
"new_status",
")",
":",
"if",
"new_status",
"not",
"in",
"VALID_PRODUCT_STATUS",
":",
"message",
"=",
"'{} is not a valid product status.'",
"raise",
"UberIllegalState",
"(",
"message",
".",
"format",
"(",
"new_status",
")",
")",
"args",
"=",
"{",
"'status'",
":",
"new_status",
"}",
"endpoint",
"=",
"'v1.2/sandbox/requests/{}'",
".",
"format",
"(",
"ride_id",
")",
"return",
"self",
".",
"_api_call",
"(",
"'PUT'",
",",
"endpoint",
",",
"args",
"=",
"args",
")"
] | Update the status of an ongoing sandbox request.
Params
ride_id (str)
The unique ID of the Ride Request.
new_status (str)
Status from VALID_PRODUCT_STATUS.
Returns
(Response)
A Response object with successful status_code
if ride status was updated. | [
"Update",
"the",
"status",
"of",
"an",
"ongoing",
"sandbox",
"request",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L602-L622 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.update_sandbox_product | def update_sandbox_product(
self,
product_id,
surge_multiplier=None,
drivers_available=None,
):
"""Update sandbox product availability.
Params
product_id (str)
Unique identifier representing a specific product for a
given location.
surge_multiplier (float)
Optional surge multiplier to manipulate pricing of product.
drivers_available (bool)
Optional boolean to manipulate availability of product.
Returns
(Response)
The Response with successful status_code
if product status was updated.
"""
args = {
'surge_multiplier': surge_multiplier,
'drivers_available': drivers_available,
}
endpoint = 'v1.2/sandbox/products/{}'.format(product_id)
return self._api_call('PUT', endpoint, args=args) | python | def update_sandbox_product(
self,
product_id,
surge_multiplier=None,
drivers_available=None,
):
"""Update sandbox product availability.
Params
product_id (str)
Unique identifier representing a specific product for a
given location.
surge_multiplier (float)
Optional surge multiplier to manipulate pricing of product.
drivers_available (bool)
Optional boolean to manipulate availability of product.
Returns
(Response)
The Response with successful status_code
if product status was updated.
"""
args = {
'surge_multiplier': surge_multiplier,
'drivers_available': drivers_available,
}
endpoint = 'v1.2/sandbox/products/{}'.format(product_id)
return self._api_call('PUT', endpoint, args=args) | [
"def",
"update_sandbox_product",
"(",
"self",
",",
"product_id",
",",
"surge_multiplier",
"=",
"None",
",",
"drivers_available",
"=",
"None",
",",
")",
":",
"args",
"=",
"{",
"'surge_multiplier'",
":",
"surge_multiplier",
",",
"'drivers_available'",
":",
"drivers_available",
",",
"}",
"endpoint",
"=",
"'v1.2/sandbox/products/{}'",
".",
"format",
"(",
"product_id",
")",
"return",
"self",
".",
"_api_call",
"(",
"'PUT'",
",",
"endpoint",
",",
"args",
"=",
"args",
")"
] | Update sandbox product availability.
Params
product_id (str)
Unique identifier representing a specific product for a
given location.
surge_multiplier (float)
Optional surge multiplier to manipulate pricing of product.
drivers_available (bool)
Optional boolean to manipulate availability of product.
Returns
(Response)
The Response with successful status_code
if product status was updated. | [
"Update",
"sandbox",
"product",
"availability",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L624-L652 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.revoke_oauth_credential | def revoke_oauth_credential(self):
"""Revoke the session's OAuth 2.0 credentials."""
if self.session.token_type == auth.SERVER_TOKEN_TYPE:
return
credential = self.session.oauth2credential
revoke_access_token(credential) | python | def revoke_oauth_credential(self):
"""Revoke the session's OAuth 2.0 credentials."""
if self.session.token_type == auth.SERVER_TOKEN_TYPE:
return
credential = self.session.oauth2credential
revoke_access_token(credential) | [
"def",
"revoke_oauth_credential",
"(",
"self",
")",
":",
"if",
"self",
".",
"session",
".",
"token_type",
"==",
"auth",
".",
"SERVER_TOKEN_TYPE",
":",
"return",
"credential",
"=",
"self",
".",
"session",
".",
"oauth2credential",
"revoke_access_token",
"(",
"credential",
")"
] | Revoke the session's OAuth 2.0 credentials. | [
"Revoke",
"the",
"session",
"s",
"OAuth",
"2",
".",
"0",
"credentials",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L722-L728 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.get_driver_trips | def get_driver_trips(self,
offset=None,
limit=None,
from_time=None,
to_time=None
):
"""Get trips about the authorized Uber driver.
Parameters
offset (int)
The integer offset for activity results. Offset the list of
returned results by this amount. Default is zero.
limit (int)
Integer amount of results to return. Number of items to
retrieve per page. Default is 10, maximum is 50.
from_time (int)
Unix timestamp of the start time to query. Queries starting
from the first trip if omitted.
to_time (int)
Unix timestamp of the end time to query. Queries starting
from the last trip if omitted.
Returns
(Response)
A Response object containing trip information.
"""
args = {
'offset': offset,
'limit': limit,
'from_time': from_time,
'to_time': to_time,
}
return self._api_call('GET', 'v1/partners/trips', args=args) | python | def get_driver_trips(self,
offset=None,
limit=None,
from_time=None,
to_time=None
):
"""Get trips about the authorized Uber driver.
Parameters
offset (int)
The integer offset for activity results. Offset the list of
returned results by this amount. Default is zero.
limit (int)
Integer amount of results to return. Number of items to
retrieve per page. Default is 10, maximum is 50.
from_time (int)
Unix timestamp of the start time to query. Queries starting
from the first trip if omitted.
to_time (int)
Unix timestamp of the end time to query. Queries starting
from the last trip if omitted.
Returns
(Response)
A Response object containing trip information.
"""
args = {
'offset': offset,
'limit': limit,
'from_time': from_time,
'to_time': to_time,
}
return self._api_call('GET', 'v1/partners/trips', args=args) | [
"def",
"get_driver_trips",
"(",
"self",
",",
"offset",
"=",
"None",
",",
"limit",
"=",
"None",
",",
"from_time",
"=",
"None",
",",
"to_time",
"=",
"None",
")",
":",
"args",
"=",
"{",
"'offset'",
":",
"offset",
",",
"'limit'",
":",
"limit",
",",
"'from_time'",
":",
"from_time",
",",
"'to_time'",
":",
"to_time",
",",
"}",
"return",
"self",
".",
"_api_call",
"(",
"'GET'",
",",
"'v1/partners/trips'",
",",
"args",
"=",
"args",
")"
] | Get trips about the authorized Uber driver.
Parameters
offset (int)
The integer offset for activity results. Offset the list of
returned results by this amount. Default is zero.
limit (int)
Integer amount of results to return. Number of items to
retrieve per page. Default is 10, maximum is 50.
from_time (int)
Unix timestamp of the start time to query. Queries starting
from the first trip if omitted.
to_time (int)
Unix timestamp of the end time to query. Queries starting
from the last trip if omitted.
Returns
(Response)
A Response object containing trip information. | [
"Get",
"trips",
"about",
"the",
"authorized",
"Uber",
"driver",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L739-L771 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.get_driver_payments | def get_driver_payments(self,
offset=None,
limit=None,
from_time=None,
to_time=None
):
"""Get payments about the authorized Uber driver.
Parameters
offset (int)
The integer offset for activity results. Offset the list of
returned results by this amount. Default is zero.
limit (int)
Integer amount of results to return. Number of items to
retrieve per page. Default is 10, maximum is 50.
from_time (int)
Unix timestamp of the start time to query. Queries starting
from the first trip if omitted.
to_time (int)
Unix timestamp of the end time to query. Queries starting
from the last trip if omitted.
Returns
(Response)
A Response object containing trip information.
"""
args = {
'offset': offset,
'limit': limit,
'from_time': from_time,
'to_time': to_time,
}
return self._api_call('GET', 'v1/partners/payments', args=args) | python | def get_driver_payments(self,
offset=None,
limit=None,
from_time=None,
to_time=None
):
"""Get payments about the authorized Uber driver.
Parameters
offset (int)
The integer offset for activity results. Offset the list of
returned results by this amount. Default is zero.
limit (int)
Integer amount of results to return. Number of items to
retrieve per page. Default is 10, maximum is 50.
from_time (int)
Unix timestamp of the start time to query. Queries starting
from the first trip if omitted.
to_time (int)
Unix timestamp of the end time to query. Queries starting
from the last trip if omitted.
Returns
(Response)
A Response object containing trip information.
"""
args = {
'offset': offset,
'limit': limit,
'from_time': from_time,
'to_time': to_time,
}
return self._api_call('GET', 'v1/partners/payments', args=args) | [
"def",
"get_driver_payments",
"(",
"self",
",",
"offset",
"=",
"None",
",",
"limit",
"=",
"None",
",",
"from_time",
"=",
"None",
",",
"to_time",
"=",
"None",
")",
":",
"args",
"=",
"{",
"'offset'",
":",
"offset",
",",
"'limit'",
":",
"limit",
",",
"'from_time'",
":",
"from_time",
",",
"'to_time'",
":",
"to_time",
",",
"}",
"return",
"self",
".",
"_api_call",
"(",
"'GET'",
",",
"'v1/partners/payments'",
",",
"args",
"=",
"args",
")"
] | Get payments about the authorized Uber driver.
Parameters
offset (int)
The integer offset for activity results. Offset the list of
returned results by this amount. Default is zero.
limit (int)
Integer amount of results to return. Number of items to
retrieve per page. Default is 10, maximum is 50.
from_time (int)
Unix timestamp of the start time to query. Queries starting
from the first trip if omitted.
to_time (int)
Unix timestamp of the end time to query. Queries starting
from the last trip if omitted.
Returns
(Response)
A Response object containing trip information. | [
"Get",
"payments",
"about",
"the",
"authorized",
"Uber",
"driver",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L773-L805 | train |
uber/rides-python-sdk | uber_rides/client.py | UberRidesClient.validiate_webhook_signature | def validiate_webhook_signature(self, webhook, signature):
"""Validates a webhook signature from a webhook body + client secret
Parameters
webhook (string)
The request body of the webhook.
signature (string)
The webhook signature specified in X-Uber-Signature header.
"""
digester = hmac.new(self.session.oauth2credential.client_secret,
webhook,
hashlib.sha256
)
return (signature == digester.hexdigest()) | python | def validiate_webhook_signature(self, webhook, signature):
"""Validates a webhook signature from a webhook body + client secret
Parameters
webhook (string)
The request body of the webhook.
signature (string)
The webhook signature specified in X-Uber-Signature header.
"""
digester = hmac.new(self.session.oauth2credential.client_secret,
webhook,
hashlib.sha256
)
return (signature == digester.hexdigest()) | [
"def",
"validiate_webhook_signature",
"(",
"self",
",",
"webhook",
",",
"signature",
")",
":",
"digester",
"=",
"hmac",
".",
"new",
"(",
"self",
".",
"session",
".",
"oauth2credential",
".",
"client_secret",
",",
"webhook",
",",
"hashlib",
".",
"sha256",
")",
"return",
"(",
"signature",
"==",
"digester",
".",
"hexdigest",
"(",
")",
")"
] | Validates a webhook signature from a webhook body + client secret
Parameters
webhook (string)
The request body of the webhook.
signature (string)
The webhook signature specified in X-Uber-Signature header. | [
"Validates",
"a",
"webhook",
"signature",
"from",
"a",
"webhook",
"body",
"+",
"client",
"secret"
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L863-L876 | train |
uber/rides-python-sdk | uber_rides/client.py | SurgeError.adapt_meta | def adapt_meta(self, meta):
"""Convert meta from error response to href and surge_id attributes."""
surge = meta.get('surge_confirmation')
href = surge.get('href')
surge_id = surge.get('surge_confirmation_id')
return href, surge_id | python | def adapt_meta(self, meta):
"""Convert meta from error response to href and surge_id attributes."""
surge = meta.get('surge_confirmation')
href = surge.get('href')
surge_id = surge.get('surge_confirmation_id')
return href, surge_id | [
"def",
"adapt_meta",
"(",
"self",
",",
"meta",
")",
":",
"surge",
"=",
"meta",
".",
"get",
"(",
"'surge_confirmation'",
")",
"href",
"=",
"surge",
".",
"get",
"(",
"'href'",
")",
"surge_id",
"=",
"surge",
".",
"get",
"(",
"'surge_confirmation_id'",
")",
"return",
"href",
",",
"surge_id"
] | Convert meta from error response to href and surge_id attributes. | [
"Convert",
"meta",
"from",
"error",
"response",
"to",
"href",
"and",
"surge_id",
"attributes",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/client.py#L928-L935 | train |
uber/rides-python-sdk | example/request_ride.py | estimate_ride | def estimate_ride(api_client):
"""Use an UberRidesClient to fetch a ride estimate and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope.
"""
try:
estimate = api_client.estimate_ride(
product_id=SURGE_PRODUCT_ID,
start_latitude=START_LAT,
start_longitude=START_LNG,
end_latitude=END_LAT,
end_longitude=END_LNG,
seat_count=2
)
except (ClientError, ServerError) as error:
fail_print(error)
else:
success_print(estimate.json) | python | def estimate_ride(api_client):
"""Use an UberRidesClient to fetch a ride estimate and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope.
"""
try:
estimate = api_client.estimate_ride(
product_id=SURGE_PRODUCT_ID,
start_latitude=START_LAT,
start_longitude=START_LNG,
end_latitude=END_LAT,
end_longitude=END_LNG,
seat_count=2
)
except (ClientError, ServerError) as error:
fail_print(error)
else:
success_print(estimate.json) | [
"def",
"estimate_ride",
"(",
"api_client",
")",
":",
"try",
":",
"estimate",
"=",
"api_client",
".",
"estimate_ride",
"(",
"product_id",
"=",
"SURGE_PRODUCT_ID",
",",
"start_latitude",
"=",
"START_LAT",
",",
"start_longitude",
"=",
"START_LNG",
",",
"end_latitude",
"=",
"END_LAT",
",",
"end_longitude",
"=",
"END_LNG",
",",
"seat_count",
"=",
"2",
")",
"except",
"(",
"ClientError",
",",
"ServerError",
")",
"as",
"error",
":",
"fail_print",
"(",
"error",
")",
"else",
":",
"success_print",
"(",
"estimate",
".",
"json",
")"
] | Use an UberRidesClient to fetch a ride estimate and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope. | [
"Use",
"an",
"UberRidesClient",
"to",
"fetch",
"a",
"ride",
"estimate",
"and",
"print",
"the",
"results",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/example/request_ride.py#L75-L96 | train |
uber/rides-python-sdk | example/request_ride.py | update_surge | def update_surge(api_client, surge_multiplier):
"""Use an UberRidesClient to update surge and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope.
surge_mutliplier (float)
The surge multiple for a sandbox product. A multiplier greater than
or equal to 2.0 will require the two stage confirmation screen.
"""
try:
update_surge = api_client.update_sandbox_product(
SURGE_PRODUCT_ID,
surge_multiplier=surge_multiplier,
)
except (ClientError, ServerError) as error:
fail_print(error)
else:
success_print(update_surge.status_code) | python | def update_surge(api_client, surge_multiplier):
"""Use an UberRidesClient to update surge and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope.
surge_mutliplier (float)
The surge multiple for a sandbox product. A multiplier greater than
or equal to 2.0 will require the two stage confirmation screen.
"""
try:
update_surge = api_client.update_sandbox_product(
SURGE_PRODUCT_ID,
surge_multiplier=surge_multiplier,
)
except (ClientError, ServerError) as error:
fail_print(error)
else:
success_print(update_surge.status_code) | [
"def",
"update_surge",
"(",
"api_client",
",",
"surge_multiplier",
")",
":",
"try",
":",
"update_surge",
"=",
"api_client",
".",
"update_sandbox_product",
"(",
"SURGE_PRODUCT_ID",
",",
"surge_multiplier",
"=",
"surge_multiplier",
",",
")",
"except",
"(",
"ClientError",
",",
"ServerError",
")",
"as",
"error",
":",
"fail_print",
"(",
"error",
")",
"else",
":",
"success_print",
"(",
"update_surge",
".",
"status_code",
")"
] | Use an UberRidesClient to update surge and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope.
surge_mutliplier (float)
The surge multiple for a sandbox product. A multiplier greater than
or equal to 2.0 will require the two stage confirmation screen. | [
"Use",
"an",
"UberRidesClient",
"to",
"update",
"surge",
"and",
"print",
"the",
"results",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/example/request_ride.py#L99-L119 | train |
uber/rides-python-sdk | example/request_ride.py | update_ride | def update_ride(api_client, ride_status, ride_id):
"""Use an UberRidesClient to update ride status and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope.
ride_status (str)
New ride status to update to.
ride_id (str)
Unique identifier for ride to update.
"""
try:
update_product = api_client.update_sandbox_ride(ride_id, ride_status)
except (ClientError, ServerError) as error:
fail_print(error)
else:
message = '{} New status: {}'
message = message.format(update_product.status_code, ride_status)
success_print(message) | python | def update_ride(api_client, ride_status, ride_id):
"""Use an UberRidesClient to update ride status and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope.
ride_status (str)
New ride status to update to.
ride_id (str)
Unique identifier for ride to update.
"""
try:
update_product = api_client.update_sandbox_ride(ride_id, ride_status)
except (ClientError, ServerError) as error:
fail_print(error)
else:
message = '{} New status: {}'
message = message.format(update_product.status_code, ride_status)
success_print(message) | [
"def",
"update_ride",
"(",
"api_client",
",",
"ride_status",
",",
"ride_id",
")",
":",
"try",
":",
"update_product",
"=",
"api_client",
".",
"update_sandbox_ride",
"(",
"ride_id",
",",
"ride_status",
")",
"except",
"(",
"ClientError",
",",
"ServerError",
")",
"as",
"error",
":",
"fail_print",
"(",
"error",
")",
"else",
":",
"message",
"=",
"'{} New status: {}'",
"message",
"=",
"message",
".",
"format",
"(",
"update_product",
".",
"status_code",
",",
"ride_status",
")",
"success_print",
"(",
"message",
")"
] | Use an UberRidesClient to update ride status and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope.
ride_status (str)
New ride status to update to.
ride_id (str)
Unique identifier for ride to update. | [
"Use",
"an",
"UberRidesClient",
"to",
"update",
"ride",
"status",
"and",
"print",
"the",
"results",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/example/request_ride.py#L122-L142 | train |
uber/rides-python-sdk | example/request_ride.py | get_ride_details | def get_ride_details(api_client, ride_id):
"""Use an UberRidesClient to get ride details and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope.
ride_id (str)
Unique ride identifier.
"""
try:
ride_details = api_client.get_ride_details(ride_id)
except (ClientError, ServerError) as error:
fail_print(error)
else:
success_print(ride_details.json) | python | def get_ride_details(api_client, ride_id):
"""Use an UberRidesClient to get ride details and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope.
ride_id (str)
Unique ride identifier.
"""
try:
ride_details = api_client.get_ride_details(ride_id)
except (ClientError, ServerError) as error:
fail_print(error)
else:
success_print(ride_details.json) | [
"def",
"get_ride_details",
"(",
"api_client",
",",
"ride_id",
")",
":",
"try",
":",
"ride_details",
"=",
"api_client",
".",
"get_ride_details",
"(",
"ride_id",
")",
"except",
"(",
"ClientError",
",",
"ServerError",
")",
"as",
"error",
":",
"fail_print",
"(",
"error",
")",
"else",
":",
"success_print",
"(",
"ride_details",
".",
"json",
")"
] | Use an UberRidesClient to get ride details and print the results.
Parameters
api_client (UberRidesClient)
An authorized UberRidesClient with 'request' scope.
ride_id (str)
Unique ride identifier. | [
"Use",
"an",
"UberRidesClient",
"to",
"get",
"ride",
"details",
"and",
"print",
"the",
"results",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/example/request_ride.py#L238-L254 | train |
uber/rides-python-sdk | uber_rides/utils/request.py | generate_data | def generate_data(method, args):
"""Assign arguments to body or URL of an HTTP request.
Parameters
method (str)
HTTP Method. (e.g. 'POST')
args (dict)
Dictionary of data to attach to each Request.
e.g. {'latitude': 37.561, 'longitude': -122.742}
Returns
(str or dict)
Either params containing the dictionary of arguments
or data containing arugments in JSON-formatted string.
"""
data = {}
params = {}
if method in http.BODY_METHODS:
data = dumps(args)
else:
params = args
return data, params | python | def generate_data(method, args):
"""Assign arguments to body or URL of an HTTP request.
Parameters
method (str)
HTTP Method. (e.g. 'POST')
args (dict)
Dictionary of data to attach to each Request.
e.g. {'latitude': 37.561, 'longitude': -122.742}
Returns
(str or dict)
Either params containing the dictionary of arguments
or data containing arugments in JSON-formatted string.
"""
data = {}
params = {}
if method in http.BODY_METHODS:
data = dumps(args)
else:
params = args
return data, params | [
"def",
"generate_data",
"(",
"method",
",",
"args",
")",
":",
"data",
"=",
"{",
"}",
"params",
"=",
"{",
"}",
"if",
"method",
"in",
"http",
".",
"BODY_METHODS",
":",
"data",
"=",
"dumps",
"(",
"args",
")",
"else",
":",
"params",
"=",
"args",
"return",
"data",
",",
"params"
] | Assign arguments to body or URL of an HTTP request.
Parameters
method (str)
HTTP Method. (e.g. 'POST')
args (dict)
Dictionary of data to attach to each Request.
e.g. {'latitude': 37.561, 'longitude': -122.742}
Returns
(str or dict)
Either params containing the dictionary of arguments
or data containing arugments in JSON-formatted string. | [
"Assign",
"arguments",
"to",
"body",
"or",
"URL",
"of",
"an",
"HTTP",
"request",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/utils/request.py#L42-L64 | train |
uber/rides-python-sdk | uber_rides/utils/request.py | generate_prepared_request | def generate_prepared_request(method, url, headers, data, params, handlers):
"""Add handlers and prepare a Request.
Parameters
method (str)
HTTP Method. (e.g. 'POST')
headers (dict)
Headers to send.
data (JSON-formatted str)
Body to attach to the request.
params (dict)
Dictionary of URL parameters to append to the URL.
handlers (list)
List of callback hooks, for error handling.
Returns
(requests.PreparedRequest)
The fully mutable PreparedRequest object,
containing the exact bytes to send to the server.
"""
request = Request(
method=method,
url=url,
headers=headers,
data=data,
params=params,
)
handlers.append(error_handler)
for handler in handlers:
request.register_hook('response', handler)
return request.prepare() | python | def generate_prepared_request(method, url, headers, data, params, handlers):
"""Add handlers and prepare a Request.
Parameters
method (str)
HTTP Method. (e.g. 'POST')
headers (dict)
Headers to send.
data (JSON-formatted str)
Body to attach to the request.
params (dict)
Dictionary of URL parameters to append to the URL.
handlers (list)
List of callback hooks, for error handling.
Returns
(requests.PreparedRequest)
The fully mutable PreparedRequest object,
containing the exact bytes to send to the server.
"""
request = Request(
method=method,
url=url,
headers=headers,
data=data,
params=params,
)
handlers.append(error_handler)
for handler in handlers:
request.register_hook('response', handler)
return request.prepare() | [
"def",
"generate_prepared_request",
"(",
"method",
",",
"url",
",",
"headers",
",",
"data",
",",
"params",
",",
"handlers",
")",
":",
"request",
"=",
"Request",
"(",
"method",
"=",
"method",
",",
"url",
"=",
"url",
",",
"headers",
"=",
"headers",
",",
"data",
"=",
"data",
",",
"params",
"=",
"params",
",",
")",
"handlers",
".",
"append",
"(",
"error_handler",
")",
"for",
"handler",
"in",
"handlers",
":",
"request",
".",
"register_hook",
"(",
"'response'",
",",
"handler",
")",
"return",
"request",
".",
"prepare",
"(",
")"
] | Add handlers and prepare a Request.
Parameters
method (str)
HTTP Method. (e.g. 'POST')
headers (dict)
Headers to send.
data (JSON-formatted str)
Body to attach to the request.
params (dict)
Dictionary of URL parameters to append to the URL.
handlers (list)
List of callback hooks, for error handling.
Returns
(requests.PreparedRequest)
The fully mutable PreparedRequest object,
containing the exact bytes to send to the server. | [
"Add",
"handlers",
"and",
"prepare",
"a",
"Request",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/utils/request.py#L67-L100 | train |
uber/rides-python-sdk | uber_rides/utils/request.py | build_url | def build_url(host, path, params=None):
"""Build a URL.
This method encodes the parameters and adds them
to the end of the base URL, then adds scheme and hostname.
Parameters
host (str)
Base URL of the Uber Server that handles API calls.
path (str)
Target path to add to the host (e.g. 'v1.2/products').
params (dict)
Optional dictionary of parameters to add to the URL.
Returns
(str)
The fully formed URL.
"""
path = quote(path)
params = params or {}
if params:
path = '/{}?{}'.format(path, urlencode(params))
else:
path = '/{}'.format(path)
if not host.startswith(http.URL_SCHEME):
host = '{}{}'.format(http.URL_SCHEME, host)
return urljoin(host, path) | python | def build_url(host, path, params=None):
"""Build a URL.
This method encodes the parameters and adds them
to the end of the base URL, then adds scheme and hostname.
Parameters
host (str)
Base URL of the Uber Server that handles API calls.
path (str)
Target path to add to the host (e.g. 'v1.2/products').
params (dict)
Optional dictionary of parameters to add to the URL.
Returns
(str)
The fully formed URL.
"""
path = quote(path)
params = params or {}
if params:
path = '/{}?{}'.format(path, urlencode(params))
else:
path = '/{}'.format(path)
if not host.startswith(http.URL_SCHEME):
host = '{}{}'.format(http.URL_SCHEME, host)
return urljoin(host, path) | [
"def",
"build_url",
"(",
"host",
",",
"path",
",",
"params",
"=",
"None",
")",
":",
"path",
"=",
"quote",
"(",
"path",
")",
"params",
"=",
"params",
"or",
"{",
"}",
"if",
"params",
":",
"path",
"=",
"'/{}?{}'",
".",
"format",
"(",
"path",
",",
"urlencode",
"(",
"params",
")",
")",
"else",
":",
"path",
"=",
"'/{}'",
".",
"format",
"(",
"path",
")",
"if",
"not",
"host",
".",
"startswith",
"(",
"http",
".",
"URL_SCHEME",
")",
":",
"host",
"=",
"'{}{}'",
".",
"format",
"(",
"http",
".",
"URL_SCHEME",
",",
"host",
")",
"return",
"urljoin",
"(",
"host",
",",
"path",
")"
] | Build a URL.
This method encodes the parameters and adds them
to the end of the base URL, then adds scheme and hostname.
Parameters
host (str)
Base URL of the Uber Server that handles API calls.
path (str)
Target path to add to the host (e.g. 'v1.2/products').
params (dict)
Optional dictionary of parameters to add to the URL.
Returns
(str)
The fully formed URL. | [
"Build",
"a",
"URL",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/utils/request.py#L103-L132 | train |
uber/rides-python-sdk | uber_rides/utils/handlers.py | error_handler | def error_handler(response, **kwargs):
"""Error Handler to surface 4XX and 5XX errors.
Attached as a callback hook on the Request object.
Parameters
response (requests.Response)
The HTTP response from an API request.
**kwargs
Arbitrary keyword arguments.
Raises
ClientError (ApiError)
Raised if response contains a 4XX status code.
ServerError (ApiError)
Raised if response contains a 5XX status code.
Returns
response (requests.Response)
The original HTTP response from the API request.
"""
try:
body = response.json()
except ValueError:
body = {}
status_code = response.status_code
message = body.get('message', '')
fields = body.get('fields', '')
error_message = str(status_code) + ': ' + message + ' ' + str(fields)
if 400 <= status_code <= 499:
raise ClientError(response, error_message)
elif 500 <= status_code <= 599:
raise ServerError(response, error_message)
return response | python | def error_handler(response, **kwargs):
"""Error Handler to surface 4XX and 5XX errors.
Attached as a callback hook on the Request object.
Parameters
response (requests.Response)
The HTTP response from an API request.
**kwargs
Arbitrary keyword arguments.
Raises
ClientError (ApiError)
Raised if response contains a 4XX status code.
ServerError (ApiError)
Raised if response contains a 5XX status code.
Returns
response (requests.Response)
The original HTTP response from the API request.
"""
try:
body = response.json()
except ValueError:
body = {}
status_code = response.status_code
message = body.get('message', '')
fields = body.get('fields', '')
error_message = str(status_code) + ': ' + message + ' ' + str(fields)
if 400 <= status_code <= 499:
raise ClientError(response, error_message)
elif 500 <= status_code <= 599:
raise ServerError(response, error_message)
return response | [
"def",
"error_handler",
"(",
"response",
",",
"*",
"*",
"kwargs",
")",
":",
"try",
":",
"body",
"=",
"response",
".",
"json",
"(",
")",
"except",
"ValueError",
":",
"body",
"=",
"{",
"}",
"status_code",
"=",
"response",
".",
"status_code",
"message",
"=",
"body",
".",
"get",
"(",
"'message'",
",",
"''",
")",
"fields",
"=",
"body",
".",
"get",
"(",
"'fields'",
",",
"''",
")",
"error_message",
"=",
"str",
"(",
"status_code",
")",
"+",
"': '",
"+",
"message",
"+",
"' '",
"+",
"str",
"(",
"fields",
")",
"if",
"400",
"<=",
"status_code",
"<=",
"499",
":",
"raise",
"ClientError",
"(",
"response",
",",
"error_message",
")",
"elif",
"500",
"<=",
"status_code",
"<=",
"599",
":",
"raise",
"ServerError",
"(",
"response",
",",
"error_message",
")",
"return",
"response"
] | Error Handler to surface 4XX and 5XX errors.
Attached as a callback hook on the Request object.
Parameters
response (requests.Response)
The HTTP response from an API request.
**kwargs
Arbitrary keyword arguments.
Raises
ClientError (ApiError)
Raised if response contains a 4XX status code.
ServerError (ApiError)
Raised if response contains a 5XX status code.
Returns
response (requests.Response)
The original HTTP response from the API request. | [
"Error",
"Handler",
"to",
"surface",
"4XX",
"and",
"5XX",
"errors",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/uber_rides/utils/handlers.py#L30-L65 | train |
uber/rides-python-sdk | example/utils.py | import_app_credentials | def import_app_credentials(filename=CREDENTIALS_FILENAME):
"""Import app credentials from configuration file.
Parameters
filename (str)
Name of configuration file.
Returns
credentials (dict)
All your app credentials and information
imported from the configuration file.
"""
with open(filename, 'r') as config_file:
config = safe_load(config_file)
client_id = config['client_id']
client_secret = config['client_secret']
redirect_url = config['redirect_url']
config_values = [client_id, client_secret, redirect_url]
for value in config_values:
if value in DEFAULT_CONFIG_VALUES:
exit('Missing credentials in {}'.format(filename))
credentials = {
'client_id': client_id,
'client_secret': client_secret,
'redirect_url': redirect_url,
'scopes': set(config['scopes']),
}
return credentials | python | def import_app_credentials(filename=CREDENTIALS_FILENAME):
"""Import app credentials from configuration file.
Parameters
filename (str)
Name of configuration file.
Returns
credentials (dict)
All your app credentials and information
imported from the configuration file.
"""
with open(filename, 'r') as config_file:
config = safe_load(config_file)
client_id = config['client_id']
client_secret = config['client_secret']
redirect_url = config['redirect_url']
config_values = [client_id, client_secret, redirect_url]
for value in config_values:
if value in DEFAULT_CONFIG_VALUES:
exit('Missing credentials in {}'.format(filename))
credentials = {
'client_id': client_id,
'client_secret': client_secret,
'redirect_url': redirect_url,
'scopes': set(config['scopes']),
}
return credentials | [
"def",
"import_app_credentials",
"(",
"filename",
"=",
"CREDENTIALS_FILENAME",
")",
":",
"with",
"open",
"(",
"filename",
",",
"'r'",
")",
"as",
"config_file",
":",
"config",
"=",
"safe_load",
"(",
"config_file",
")",
"client_id",
"=",
"config",
"[",
"'client_id'",
"]",
"client_secret",
"=",
"config",
"[",
"'client_secret'",
"]",
"redirect_url",
"=",
"config",
"[",
"'redirect_url'",
"]",
"config_values",
"=",
"[",
"client_id",
",",
"client_secret",
",",
"redirect_url",
"]",
"for",
"value",
"in",
"config_values",
":",
"if",
"value",
"in",
"DEFAULT_CONFIG_VALUES",
":",
"exit",
"(",
"'Missing credentials in {}'",
".",
"format",
"(",
"filename",
")",
")",
"credentials",
"=",
"{",
"'client_id'",
":",
"client_id",
",",
"'client_secret'",
":",
"client_secret",
",",
"'redirect_url'",
":",
"redirect_url",
",",
"'scopes'",
":",
"set",
"(",
"config",
"[",
"'scopes'",
"]",
")",
",",
"}",
"return",
"credentials"
] | Import app credentials from configuration file.
Parameters
filename (str)
Name of configuration file.
Returns
credentials (dict)
All your app credentials and information
imported from the configuration file. | [
"Import",
"app",
"credentials",
"from",
"configuration",
"file",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/example/utils.py#L98-L130 | train |
uber/rides-python-sdk | example/utils.py | create_uber_client | def create_uber_client(credentials):
"""Create an UberRidesClient from OAuth 2.0 credentials.
Parameters
credentials (dict)
Dictionary of OAuth 2.0 credentials.
Returns
(UberRidesClient)
An authorized UberRidesClient to access API resources.
"""
oauth2credential = OAuth2Credential(
client_id=credentials.get('client_id'),
access_token=credentials.get('access_token'),
expires_in_seconds=credentials.get('expires_in_seconds'),
scopes=credentials.get('scopes'),
grant_type=credentials.get('grant_type'),
redirect_url=credentials.get('redirect_url'),
client_secret=credentials.get('client_secret'),
refresh_token=credentials.get('refresh_token'),
)
session = Session(oauth2credential=oauth2credential)
return UberRidesClient(session, sandbox_mode=True) | python | def create_uber_client(credentials):
"""Create an UberRidesClient from OAuth 2.0 credentials.
Parameters
credentials (dict)
Dictionary of OAuth 2.0 credentials.
Returns
(UberRidesClient)
An authorized UberRidesClient to access API resources.
"""
oauth2credential = OAuth2Credential(
client_id=credentials.get('client_id'),
access_token=credentials.get('access_token'),
expires_in_seconds=credentials.get('expires_in_seconds'),
scopes=credentials.get('scopes'),
grant_type=credentials.get('grant_type'),
redirect_url=credentials.get('redirect_url'),
client_secret=credentials.get('client_secret'),
refresh_token=credentials.get('refresh_token'),
)
session = Session(oauth2credential=oauth2credential)
return UberRidesClient(session, sandbox_mode=True) | [
"def",
"create_uber_client",
"(",
"credentials",
")",
":",
"oauth2credential",
"=",
"OAuth2Credential",
"(",
"client_id",
"=",
"credentials",
".",
"get",
"(",
"'client_id'",
")",
",",
"access_token",
"=",
"credentials",
".",
"get",
"(",
"'access_token'",
")",
",",
"expires_in_seconds",
"=",
"credentials",
".",
"get",
"(",
"'expires_in_seconds'",
")",
",",
"scopes",
"=",
"credentials",
".",
"get",
"(",
"'scopes'",
")",
",",
"grant_type",
"=",
"credentials",
".",
"get",
"(",
"'grant_type'",
")",
",",
"redirect_url",
"=",
"credentials",
".",
"get",
"(",
"'redirect_url'",
")",
",",
"client_secret",
"=",
"credentials",
".",
"get",
"(",
"'client_secret'",
")",
",",
"refresh_token",
"=",
"credentials",
".",
"get",
"(",
"'refresh_token'",
")",
",",
")",
"session",
"=",
"Session",
"(",
"oauth2credential",
"=",
"oauth2credential",
")",
"return",
"UberRidesClient",
"(",
"session",
",",
"sandbox_mode",
"=",
"True",
")"
] | Create an UberRidesClient from OAuth 2.0 credentials.
Parameters
credentials (dict)
Dictionary of OAuth 2.0 credentials.
Returns
(UberRidesClient)
An authorized UberRidesClient to access API resources. | [
"Create",
"an",
"UberRidesClient",
"from",
"OAuth",
"2",
".",
"0",
"credentials",
"."
] | 76ecd75ab5235d792ec1010e36eca679ba285127 | https://github.com/uber/rides-python-sdk/blob/76ecd75ab5235d792ec1010e36eca679ba285127/example/utils.py#L167-L189 | train |
kigawas/eciespy | ecies/__init__.py | encrypt | def encrypt(receiver_pubhex: str, msg: bytes) -> bytes:
"""
Encrypt with eth public key
Parameters
----------
receiver_pubhex: str
Receiver's ethereum public key hex string
msg: bytes
Data to encrypt
Returns
-------
bytes
Encrypted data
"""
disposable_key = generate_key()
receiver_pubkey = hex2pub(receiver_pubhex)
aes_key = derive(disposable_key, receiver_pubkey)
cipher_text = aes_encrypt(aes_key, msg)
return disposable_key.public_key.format(False) + cipher_text | python | def encrypt(receiver_pubhex: str, msg: bytes) -> bytes:
"""
Encrypt with eth public key
Parameters
----------
receiver_pubhex: str
Receiver's ethereum public key hex string
msg: bytes
Data to encrypt
Returns
-------
bytes
Encrypted data
"""
disposable_key = generate_key()
receiver_pubkey = hex2pub(receiver_pubhex)
aes_key = derive(disposable_key, receiver_pubkey)
cipher_text = aes_encrypt(aes_key, msg)
return disposable_key.public_key.format(False) + cipher_text | [
"def",
"encrypt",
"(",
"receiver_pubhex",
":",
"str",
",",
"msg",
":",
"bytes",
")",
"->",
"bytes",
":",
"disposable_key",
"=",
"generate_key",
"(",
")",
"receiver_pubkey",
"=",
"hex2pub",
"(",
"receiver_pubhex",
")",
"aes_key",
"=",
"derive",
"(",
"disposable_key",
",",
"receiver_pubkey",
")",
"cipher_text",
"=",
"aes_encrypt",
"(",
"aes_key",
",",
"msg",
")",
"return",
"disposable_key",
".",
"public_key",
".",
"format",
"(",
"False",
")",
"+",
"cipher_text"
] | Encrypt with eth public key
Parameters
----------
receiver_pubhex: str
Receiver's ethereum public key hex string
msg: bytes
Data to encrypt
Returns
-------
bytes
Encrypted data | [
"Encrypt",
"with",
"eth",
"public",
"key"
] | 233f3d7726bf03465a6b2470e83f34cc457eea6c | https://github.com/kigawas/eciespy/blob/233f3d7726bf03465a6b2470e83f34cc457eea6c/ecies/__init__.py#L6-L26 | train |
kigawas/eciespy | ecies/__init__.py | decrypt | def decrypt(receiver_prvhex: str, msg: bytes) -> bytes:
"""
Decrypt with eth private key
Parameters
----------
receiver_pubhex: str
Receiver's ethereum private key hex string
msg: bytes
Data to decrypt
Returns
-------
bytes
Plain text
"""
pubkey = msg[0:65] # pubkey's length is 65 bytes
encrypted = msg[65:]
sender_public_key = hex2pub(pubkey.hex())
private_key = hex2prv(receiver_prvhex)
aes_key = derive(private_key, sender_public_key)
return aes_decrypt(aes_key, encrypted) | python | def decrypt(receiver_prvhex: str, msg: bytes) -> bytes:
"""
Decrypt with eth private key
Parameters
----------
receiver_pubhex: str
Receiver's ethereum private key hex string
msg: bytes
Data to decrypt
Returns
-------
bytes
Plain text
"""
pubkey = msg[0:65] # pubkey's length is 65 bytes
encrypted = msg[65:]
sender_public_key = hex2pub(pubkey.hex())
private_key = hex2prv(receiver_prvhex)
aes_key = derive(private_key, sender_public_key)
return aes_decrypt(aes_key, encrypted) | [
"def",
"decrypt",
"(",
"receiver_prvhex",
":",
"str",
",",
"msg",
":",
"bytes",
")",
"->",
"bytes",
":",
"pubkey",
"=",
"msg",
"[",
"0",
":",
"65",
"]",
"# pubkey's length is 65 bytes",
"encrypted",
"=",
"msg",
"[",
"65",
":",
"]",
"sender_public_key",
"=",
"hex2pub",
"(",
"pubkey",
".",
"hex",
"(",
")",
")",
"private_key",
"=",
"hex2prv",
"(",
"receiver_prvhex",
")",
"aes_key",
"=",
"derive",
"(",
"private_key",
",",
"sender_public_key",
")",
"return",
"aes_decrypt",
"(",
"aes_key",
",",
"encrypted",
")"
] | Decrypt with eth private key
Parameters
----------
receiver_pubhex: str
Receiver's ethereum private key hex string
msg: bytes
Data to decrypt
Returns
-------
bytes
Plain text | [
"Decrypt",
"with",
"eth",
"private",
"key"
] | 233f3d7726bf03465a6b2470e83f34cc457eea6c | https://github.com/kigawas/eciespy/blob/233f3d7726bf03465a6b2470e83f34cc457eea6c/ecies/__init__.py#L29-L50 | train |
kigawas/eciespy | ecies/utils.py | hex2pub | def hex2pub(pub_hex: str) -> PublicKey:
"""
Convert ethereum hex to EllipticCurvePublicKey
The hex should be 65 bytes, but ethereum public key only has 64 bytes
So have to add \x04
Parameters
----------
pub_hex: str
Ethereum public key hex string
Returns
-------
coincurve.PublicKey
A secp256k1 public key calculated from ethereum public key hex string
>>> data = b'0'*32
>>> data_hash = sha256(data)
>>> eth_prv = generate_eth_key()
>>> cc_prv = hex2prv(eth_prv.to_hex())
>>> eth_prv.sign_msg_hash(data_hash).to_bytes() == cc_prv.sign_recoverable(data)
True
>>> pubhex = eth_prv.public_key.to_hex()
>>> computed_pub = hex2pub(pubhex)
>>> computed_pub == cc_prv.public_key
True
"""
uncompressed = decode_hex(pub_hex)
if len(uncompressed) == 64:
uncompressed = b"\x04" + uncompressed
return PublicKey(uncompressed) | python | def hex2pub(pub_hex: str) -> PublicKey:
"""
Convert ethereum hex to EllipticCurvePublicKey
The hex should be 65 bytes, but ethereum public key only has 64 bytes
So have to add \x04
Parameters
----------
pub_hex: str
Ethereum public key hex string
Returns
-------
coincurve.PublicKey
A secp256k1 public key calculated from ethereum public key hex string
>>> data = b'0'*32
>>> data_hash = sha256(data)
>>> eth_prv = generate_eth_key()
>>> cc_prv = hex2prv(eth_prv.to_hex())
>>> eth_prv.sign_msg_hash(data_hash).to_bytes() == cc_prv.sign_recoverable(data)
True
>>> pubhex = eth_prv.public_key.to_hex()
>>> computed_pub = hex2pub(pubhex)
>>> computed_pub == cc_prv.public_key
True
"""
uncompressed = decode_hex(pub_hex)
if len(uncompressed) == 64:
uncompressed = b"\x04" + uncompressed
return PublicKey(uncompressed) | [
"def",
"hex2pub",
"(",
"pub_hex",
":",
"str",
")",
"->",
"PublicKey",
":",
"uncompressed",
"=",
"decode_hex",
"(",
"pub_hex",
")",
"if",
"len",
"(",
"uncompressed",
")",
"==",
"64",
":",
"uncompressed",
"=",
"b\"\\x04\"",
"+",
"uncompressed",
"return",
"PublicKey",
"(",
"uncompressed",
")"
] | Convert ethereum hex to EllipticCurvePublicKey
The hex should be 65 bytes, but ethereum public key only has 64 bytes
So have to add \x04
Parameters
----------
pub_hex: str
Ethereum public key hex string
Returns
-------
coincurve.PublicKey
A secp256k1 public key calculated from ethereum public key hex string
>>> data = b'0'*32
>>> data_hash = sha256(data)
>>> eth_prv = generate_eth_key()
>>> cc_prv = hex2prv(eth_prv.to_hex())
>>> eth_prv.sign_msg_hash(data_hash).to_bytes() == cc_prv.sign_recoverable(data)
True
>>> pubhex = eth_prv.public_key.to_hex()
>>> computed_pub = hex2pub(pubhex)
>>> computed_pub == cc_prv.public_key
True | [
"Convert",
"ethereum",
"hex",
"to",
"EllipticCurvePublicKey",
"The",
"hex",
"should",
"be",
"65",
"bytes",
"but",
"ethereum",
"public",
"key",
"only",
"has",
"64",
"bytes",
"So",
"have",
"to",
"add",
"\\",
"x04"
] | 233f3d7726bf03465a6b2470e83f34cc457eea6c | https://github.com/kigawas/eciespy/blob/233f3d7726bf03465a6b2470e83f34cc457eea6c/ecies/utils.py#L73-L104 | train |
kigawas/eciespy | ecies/utils.py | aes_encrypt | def aes_encrypt(key: bytes, plain_text: bytes) -> bytes:
"""
AES-GCM encryption
Parameters
----------
key: bytes
AES session key, which derived from two secp256k1 keys
plain_text: bytes
Plain text to encrypt
Returns
-------
bytes
nonce(16 bytes) + tag(16 bytes) + encrypted data
"""
aes_cipher = AES.new(key, AES_CIPHER_MODE)
encrypted, tag = aes_cipher.encrypt_and_digest(plain_text)
cipher_text = bytearray()
cipher_text.extend(aes_cipher.nonce)
cipher_text.extend(tag)
cipher_text.extend(encrypted)
return bytes(cipher_text) | python | def aes_encrypt(key: bytes, plain_text: bytes) -> bytes:
"""
AES-GCM encryption
Parameters
----------
key: bytes
AES session key, which derived from two secp256k1 keys
plain_text: bytes
Plain text to encrypt
Returns
-------
bytes
nonce(16 bytes) + tag(16 bytes) + encrypted data
"""
aes_cipher = AES.new(key, AES_CIPHER_MODE)
encrypted, tag = aes_cipher.encrypt_and_digest(plain_text)
cipher_text = bytearray()
cipher_text.extend(aes_cipher.nonce)
cipher_text.extend(tag)
cipher_text.extend(encrypted)
return bytes(cipher_text) | [
"def",
"aes_encrypt",
"(",
"key",
":",
"bytes",
",",
"plain_text",
":",
"bytes",
")",
"->",
"bytes",
":",
"aes_cipher",
"=",
"AES",
".",
"new",
"(",
"key",
",",
"AES_CIPHER_MODE",
")",
"encrypted",
",",
"tag",
"=",
"aes_cipher",
".",
"encrypt_and_digest",
"(",
"plain_text",
")",
"cipher_text",
"=",
"bytearray",
"(",
")",
"cipher_text",
".",
"extend",
"(",
"aes_cipher",
".",
"nonce",
")",
"cipher_text",
".",
"extend",
"(",
"tag",
")",
"cipher_text",
".",
"extend",
"(",
"encrypted",
")",
"return",
"bytes",
"(",
"cipher_text",
")"
] | AES-GCM encryption
Parameters
----------
key: bytes
AES session key, which derived from two secp256k1 keys
plain_text: bytes
Plain text to encrypt
Returns
-------
bytes
nonce(16 bytes) + tag(16 bytes) + encrypted data | [
"AES",
"-",
"GCM",
"encryption"
] | 233f3d7726bf03465a6b2470e83f34cc457eea6c | https://github.com/kigawas/eciespy/blob/233f3d7726bf03465a6b2470e83f34cc457eea6c/ecies/utils.py#L159-L182 | train |
kigawas/eciespy | ecies/utils.py | aes_decrypt | def aes_decrypt(key: bytes, cipher_text: bytes) -> bytes:
"""
AES-GCM decryption
Parameters
----------
key: bytes
AES session key, which derived from two secp256k1 keys
cipher_text: bytes
Encrypted text:
nonce(16 bytes) + tag(16 bytes) + encrypted data
Returns
-------
bytes
Plain text
>>> data = b'this is test data'
>>> key = get_valid_secret()
>>> aes_decrypt(key, aes_encrypt(key, data)) == data
True
>>> import os
>>> key = os.urandom(32)
>>> aes_decrypt(key, aes_encrypt(key, data)) == data
True
"""
nonce = cipher_text[:16]
tag = cipher_text[16:32]
ciphered_data = cipher_text[32:]
aes_cipher = AES.new(key, AES_CIPHER_MODE, nonce=nonce)
return aes_cipher.decrypt_and_verify(ciphered_data, tag) | python | def aes_decrypt(key: bytes, cipher_text: bytes) -> bytes:
"""
AES-GCM decryption
Parameters
----------
key: bytes
AES session key, which derived from two secp256k1 keys
cipher_text: bytes
Encrypted text:
nonce(16 bytes) + tag(16 bytes) + encrypted data
Returns
-------
bytes
Plain text
>>> data = b'this is test data'
>>> key = get_valid_secret()
>>> aes_decrypt(key, aes_encrypt(key, data)) == data
True
>>> import os
>>> key = os.urandom(32)
>>> aes_decrypt(key, aes_encrypt(key, data)) == data
True
"""
nonce = cipher_text[:16]
tag = cipher_text[16:32]
ciphered_data = cipher_text[32:]
aes_cipher = AES.new(key, AES_CIPHER_MODE, nonce=nonce)
return aes_cipher.decrypt_and_verify(ciphered_data, tag) | [
"def",
"aes_decrypt",
"(",
"key",
":",
"bytes",
",",
"cipher_text",
":",
"bytes",
")",
"->",
"bytes",
":",
"nonce",
"=",
"cipher_text",
"[",
":",
"16",
"]",
"tag",
"=",
"cipher_text",
"[",
"16",
":",
"32",
"]",
"ciphered_data",
"=",
"cipher_text",
"[",
"32",
":",
"]",
"aes_cipher",
"=",
"AES",
".",
"new",
"(",
"key",
",",
"AES_CIPHER_MODE",
",",
"nonce",
"=",
"nonce",
")",
"return",
"aes_cipher",
".",
"decrypt_and_verify",
"(",
"ciphered_data",
",",
"tag",
")"
] | AES-GCM decryption
Parameters
----------
key: bytes
AES session key, which derived from two secp256k1 keys
cipher_text: bytes
Encrypted text:
nonce(16 bytes) + tag(16 bytes) + encrypted data
Returns
-------
bytes
Plain text
>>> data = b'this is test data'
>>> key = get_valid_secret()
>>> aes_decrypt(key, aes_encrypt(key, data)) == data
True
>>> import os
>>> key = os.urandom(32)
>>> aes_decrypt(key, aes_encrypt(key, data)) == data
True | [
"AES",
"-",
"GCM",
"decryption"
] | 233f3d7726bf03465a6b2470e83f34cc457eea6c | https://github.com/kigawas/eciespy/blob/233f3d7726bf03465a6b2470e83f34cc457eea6c/ecies/utils.py#L185-L216 | train |
wtolson/pysis | pysis/cubefile.py | CubeFile.apply_scaling | def apply_scaling(self, copy=True):
"""Scale pixel values to there true DN.
:param copy: whether to apply the scalling to a copy of the pixel data
and leave the orginial unaffected
:returns: a scalled version of the pixel data
"""
if copy:
return self.multiplier * self.data + self.base
if self.multiplier != 1:
self.data *= self.multiplier
if self.base != 0:
self.data += self.base
return self.data | python | def apply_scaling(self, copy=True):
"""Scale pixel values to there true DN.
:param copy: whether to apply the scalling to a copy of the pixel data
and leave the orginial unaffected
:returns: a scalled version of the pixel data
"""
if copy:
return self.multiplier * self.data + self.base
if self.multiplier != 1:
self.data *= self.multiplier
if self.base != 0:
self.data += self.base
return self.data | [
"def",
"apply_scaling",
"(",
"self",
",",
"copy",
"=",
"True",
")",
":",
"if",
"copy",
":",
"return",
"self",
".",
"multiplier",
"*",
"self",
".",
"data",
"+",
"self",
".",
"base",
"if",
"self",
".",
"multiplier",
"!=",
"1",
":",
"self",
".",
"data",
"*=",
"self",
".",
"multiplier",
"if",
"self",
".",
"base",
"!=",
"0",
":",
"self",
".",
"data",
"+=",
"self",
".",
"base",
"return",
"self",
".",
"data"
] | Scale pixel values to there true DN.
:param copy: whether to apply the scalling to a copy of the pixel data
and leave the orginial unaffected
:returns: a scalled version of the pixel data | [
"Scale",
"pixel",
"values",
"to",
"there",
"true",
"DN",
"."
] | 7b907c8104bddfbb14c603de4d666c2101e1f999 | https://github.com/wtolson/pysis/blob/7b907c8104bddfbb14c603de4d666c2101e1f999/pysis/cubefile.py#L65-L82 | train |
wtolson/pysis | pysis/cubefile.py | CubeFile.specials_mask | def specials_mask(self):
"""Create a pixel map for special pixels.
:returns: an array where the value is `False` if the pixel is special
and `True` otherwise
"""
mask = self.data >= self.specials['Min']
mask &= self.data <= self.specials['Max']
return mask | python | def specials_mask(self):
"""Create a pixel map for special pixels.
:returns: an array where the value is `False` if the pixel is special
and `True` otherwise
"""
mask = self.data >= self.specials['Min']
mask &= self.data <= self.specials['Max']
return mask | [
"def",
"specials_mask",
"(",
"self",
")",
":",
"mask",
"=",
"self",
".",
"data",
">=",
"self",
".",
"specials",
"[",
"'Min'",
"]",
"mask",
"&=",
"self",
".",
"data",
"<=",
"self",
".",
"specials",
"[",
"'Max'",
"]",
"return",
"mask"
] | Create a pixel map for special pixels.
:returns: an array where the value is `False` if the pixel is special
and `True` otherwise | [
"Create",
"a",
"pixel",
"map",
"for",
"special",
"pixels",
"."
] | 7b907c8104bddfbb14c603de4d666c2101e1f999 | https://github.com/wtolson/pysis/blob/7b907c8104bddfbb14c603de4d666c2101e1f999/pysis/cubefile.py#L122-L130 | train |