id int32 0 252k | 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 51 19.8k | code_tokens list | docstring stringlengths 3 17.3k | docstring_tokens list | sha stringlengths 40 40 | url stringlengths 87 242 |
|---|---|---|---|---|---|---|---|---|---|---|---|
243,500 | MicroPyramid/forex-python | forex_python/bitcoin.py | BtcConverter.convert_to_btc | def convert_to_btc(self, amount, currency):
"""
Convert X amount to Bit Coins
"""
if isinstance(amount, Decimal):
use_decimal = True
else:
use_decimal = self._force_decimal
url = 'https://api.coindesk.com/v1/bpi/currentprice/{}.json'.format(curren... | python | def convert_to_btc(self, amount, currency):
if isinstance(amount, Decimal):
use_decimal = True
else:
use_decimal = self._force_decimal
url = 'https://api.coindesk.com/v1/bpi/currentprice/{}.json'.format(currency)
response = requests.get(url)
if response.s... | [
"def",
"convert_to_btc",
"(",
"self",
",",
"amount",
",",
"currency",
")",
":",
"if",
"isinstance",
"(",
"amount",
",",
"Decimal",
")",
":",
"use_decimal",
"=",
"True",
"else",
":",
"use_decimal",
"=",
"self",
".",
"_force_decimal",
"url",
"=",
"'https://a... | Convert X amount to Bit Coins | [
"Convert",
"X",
"amount",
"to",
"Bit",
"Coins"
] | dc34868ec7c7eb49b3b963d6daa3897b7095ba09 | https://github.com/MicroPyramid/forex-python/blob/dc34868ec7c7eb49b3b963d6daa3897b7095ba09/forex_python/bitcoin.py#L75-L97 |
243,501 | MicroPyramid/forex-python | forex_python/bitcoin.py | BtcConverter.convert_btc_to_cur | def convert_btc_to_cur(self, coins, currency):
"""
Convert X bit coins to valid currency amount
"""
if isinstance(coins, Decimal):
use_decimal = True
else:
use_decimal = self._force_decimal
url = 'https://api.coindesk.com/v1/bpi/currentprice/{}.js... | python | def convert_btc_to_cur(self, coins, currency):
if isinstance(coins, Decimal):
use_decimal = True
else:
use_decimal = self._force_decimal
url = 'https://api.coindesk.com/v1/bpi/currentprice/{}.json'.format(currency)
response = requests.get(url)
if response... | [
"def",
"convert_btc_to_cur",
"(",
"self",
",",
"coins",
",",
"currency",
")",
":",
"if",
"isinstance",
"(",
"coins",
",",
"Decimal",
")",
":",
"use_decimal",
"=",
"True",
"else",
":",
"use_decimal",
"=",
"self",
".",
"_force_decimal",
"url",
"=",
"'https:/... | Convert X bit coins to valid currency amount | [
"Convert",
"X",
"bit",
"coins",
"to",
"valid",
"currency",
"amount"
] | dc34868ec7c7eb49b3b963d6daa3897b7095ba09 | https://github.com/MicroPyramid/forex-python/blob/dc34868ec7c7eb49b3b963d6daa3897b7095ba09/forex_python/bitcoin.py#L99-L121 |
243,502 | MicroPyramid/forex-python | forex_python/bitcoin.py | BtcConverter.convert_to_btc_on | def convert_to_btc_on(self, amount, currency, date_obj):
"""
Convert X amount to BTC based on given date rate
"""
if isinstance(amount, Decimal):
use_decimal = True
else:
use_decimal = self._force_decimal
start = date_obj.strftime('%Y-%m-%d')
... | python | def convert_to_btc_on(self, amount, currency, date_obj):
if isinstance(amount, Decimal):
use_decimal = True
else:
use_decimal = self._force_decimal
start = date_obj.strftime('%Y-%m-%d')
end = date_obj.strftime('%Y-%m-%d')
url = (
'https://api.... | [
"def",
"convert_to_btc_on",
"(",
"self",
",",
"amount",
",",
"currency",
",",
"date_obj",
")",
":",
"if",
"isinstance",
"(",
"amount",
",",
"Decimal",
")",
":",
"use_decimal",
"=",
"True",
"else",
":",
"use_decimal",
"=",
"self",
".",
"_force_decimal",
"st... | Convert X amount to BTC based on given date rate | [
"Convert",
"X",
"amount",
"to",
"BTC",
"based",
"on",
"given",
"date",
"rate"
] | dc34868ec7c7eb49b3b963d6daa3897b7095ba09 | https://github.com/MicroPyramid/forex-python/blob/dc34868ec7c7eb49b3b963d6daa3897b7095ba09/forex_python/bitcoin.py#L123-L152 |
243,503 | DocNow/twarc | twarc/decorators.py | rate_limit | def rate_limit(f):
"""
A decorator to handle rate limiting from the Twitter API. If
a rate limit error is encountered we will sleep until we can
issue the API call again.
"""
def new_f(*args, **kwargs):
errors = 0
while True:
resp = f(*args, **kwargs)
if r... | python | def rate_limit(f):
def new_f(*args, **kwargs):
errors = 0
while True:
resp = f(*args, **kwargs)
if resp.status_code == 200:
errors = 0
return resp
elif resp.status_code == 401:
# Hack to retain the original exception... | [
"def",
"rate_limit",
"(",
"f",
")",
":",
"def",
"new_f",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"errors",
"=",
"0",
"while",
"True",
":",
"resp",
"=",
"f",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"if",
"resp",
".",
"stat... | A decorator to handle rate limiting from the Twitter API. If
a rate limit error is encountered we will sleep until we can
issue the API call again. | [
"A",
"decorator",
"to",
"handle",
"rate",
"limiting",
"from",
"the",
"Twitter",
"API",
".",
"If",
"a",
"rate",
"limit",
"error",
"is",
"encountered",
"we",
"will",
"sleep",
"until",
"we",
"can",
"issue",
"the",
"API",
"call",
"again",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/decorators.py#L8-L53 |
243,504 | DocNow/twarc | twarc/decorators.py | catch_timeout | def catch_timeout(f):
"""
A decorator to handle read timeouts from Twitter.
"""
def new_f(self, *args, **kwargs):
try:
return f(self, *args, **kwargs)
except (requests.exceptions.ReadTimeout,
requests.packages.urllib3.exceptions.ReadTimeoutError) as e:
... | python | def catch_timeout(f):
def new_f(self, *args, **kwargs):
try:
return f(self, *args, **kwargs)
except (requests.exceptions.ReadTimeout,
requests.packages.urllib3.exceptions.ReadTimeoutError) as e:
log.warning("caught read timeout: %s", e)
self.connec... | [
"def",
"catch_timeout",
"(",
"f",
")",
":",
"def",
"new_f",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"try",
":",
"return",
"f",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"except",
"(",
"requests",
"."... | A decorator to handle read timeouts from Twitter. | [
"A",
"decorator",
"to",
"handle",
"read",
"timeouts",
"from",
"Twitter",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/decorators.py#L81-L93 |
243,505 | DocNow/twarc | twarc/decorators.py | catch_gzip_errors | def catch_gzip_errors(f):
"""
A decorator to handle gzip encoding errors which have been known to
happen during hydration.
"""
def new_f(self, *args, **kwargs):
try:
return f(self, *args, **kwargs)
except requests.exceptions.ContentDecodingError as e:
log.warn... | python | def catch_gzip_errors(f):
def new_f(self, *args, **kwargs):
try:
return f(self, *args, **kwargs)
except requests.exceptions.ContentDecodingError as e:
log.warning("caught gzip error: %s", e)
self.connect()
return f(self, *args, **kwargs)
return new... | [
"def",
"catch_gzip_errors",
"(",
"f",
")",
":",
"def",
"new_f",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"try",
":",
"return",
"f",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"except",
"requests",
".",
... | A decorator to handle gzip encoding errors which have been known to
happen during hydration. | [
"A",
"decorator",
"to",
"handle",
"gzip",
"encoding",
"errors",
"which",
"have",
"been",
"known",
"to",
"happen",
"during",
"hydration",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/decorators.py#L96-L108 |
243,506 | DocNow/twarc | twarc/decorators.py | interruptible_sleep | def interruptible_sleep(t, event=None):
"""
Sleeps for a specified duration, optionally stopping early for event.
Returns True if interrupted
"""
log.info("sleeping %s", t)
if event is None:
time.sleep(t)
return False
else:
return not event.wait(t) | python | def interruptible_sleep(t, event=None):
log.info("sleeping %s", t)
if event is None:
time.sleep(t)
return False
else:
return not event.wait(t) | [
"def",
"interruptible_sleep",
"(",
"t",
",",
"event",
"=",
"None",
")",
":",
"log",
".",
"info",
"(",
"\"sleeping %s\"",
",",
"t",
")",
"if",
"event",
"is",
"None",
":",
"time",
".",
"sleep",
"(",
"t",
")",
"return",
"False",
"else",
":",
"return",
... | Sleeps for a specified duration, optionally stopping early for event.
Returns True if interrupted | [
"Sleeps",
"for",
"a",
"specified",
"duration",
"optionally",
"stopping",
"early",
"for",
"event",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/decorators.py#L111-L123 |
243,507 | DocNow/twarc | twarc/decorators.py | filter_protected | def filter_protected(f):
"""
filter_protected will filter out protected tweets and users unless
explicitly requested not to.
"""
def new_f(self, *args, **kwargs):
for obj in f(self, *args, **kwargs):
if self.protected == False:
if 'user' in obj and obj['user']['pr... | python | def filter_protected(f):
def new_f(self, *args, **kwargs):
for obj in f(self, *args, **kwargs):
if self.protected == False:
if 'user' in obj and obj['user']['protected']:
continue
elif 'protected' in obj and obj['protected']:
... | [
"def",
"filter_protected",
"(",
"f",
")",
":",
"def",
"new_f",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"for",
"obj",
"in",
"f",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"self",
".",
"pr... | filter_protected will filter out protected tweets and users unless
explicitly requested not to. | [
"filter_protected",
"will",
"filter",
"out",
"protected",
"tweets",
"and",
"users",
"unless",
"explicitly",
"requested",
"not",
"to",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/decorators.py#L125-L139 |
243,508 | DocNow/twarc | utils/extractor.py | tweets_files | def tweets_files(string, path):
"""Iterates over json files in path."""
for filename in os.listdir(path):
if re.match(string, filename) and ".jsonl" in filename:
f = gzip.open if ".gz" in filename else open
yield path + filename, f
Ellipsis | python | def tweets_files(string, path):
for filename in os.listdir(path):
if re.match(string, filename) and ".jsonl" in filename:
f = gzip.open if ".gz" in filename else open
yield path + filename, f
Ellipsis | [
"def",
"tweets_files",
"(",
"string",
",",
"path",
")",
":",
"for",
"filename",
"in",
"os",
".",
"listdir",
"(",
"path",
")",
":",
"if",
"re",
".",
"match",
"(",
"string",
",",
"filename",
")",
"and",
"\".jsonl\"",
"in",
"filename",
":",
"f",
"=",
... | Iterates over json files in path. | [
"Iterates",
"over",
"json",
"files",
"in",
"path",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/utils/extractor.py#L38-L45 |
243,509 | DocNow/twarc | utils/extractor.py | extract | def extract(json_object, args, csv_writer):
"""Extract and write found attributes."""
found = [[]]
for attribute in args.attributes:
item = attribute.getElement(json_object)
if len(item) == 0:
for row in found:
row.append("NA")
else:
found1 = [... | python | def extract(json_object, args, csv_writer):
found = [[]]
for attribute in args.attributes:
item = attribute.getElement(json_object)
if len(item) == 0:
for row in found:
row.append("NA")
else:
found1 = []
for value in item:
... | [
"def",
"extract",
"(",
"json_object",
",",
"args",
",",
"csv_writer",
")",
":",
"found",
"=",
"[",
"[",
"]",
"]",
"for",
"attribute",
"in",
"args",
".",
"attributes",
":",
"item",
"=",
"attribute",
".",
"getElement",
"(",
"json_object",
")",
"if",
"len... | Extract and write found attributes. | [
"Extract",
"and",
"write",
"found",
"attributes",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/utils/extractor.py#L91-L113 |
243,510 | DocNow/twarc | utils/network.py | add | def add(from_user, from_id, to_user, to_id, type):
"adds a relation to the graph"
if options.users and to_user:
G.add_node(from_user, screen_name=from_user)
G.add_node(to_user, screen_name=to_user)
if G.has_edge(from_user, to_user):
weight = G[from_user][to_user]['we... | python | def add(from_user, from_id, to_user, to_id, type):
"adds a relation to the graph"
if options.users and to_user:
G.add_node(from_user, screen_name=from_user)
G.add_node(to_user, screen_name=to_user)
if G.has_edge(from_user, to_user):
weight = G[from_user][to_user]['we... | [
"def",
"add",
"(",
"from_user",
",",
"from_id",
",",
"to_user",
",",
"to_id",
",",
"type",
")",
":",
"if",
"options",
".",
"users",
"and",
"to_user",
":",
"G",
".",
"add_node",
"(",
"from_user",
",",
"screen_name",
"=",
"from_user",
")",
"G",
".",
"a... | adds a relation to the graph | [
"adds",
"a",
"relation",
"to",
"the",
"graph"
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/utils/network.py#L72-L91 |
243,511 | DocNow/twarc | twarc/client.py | Twarc.timeline | def timeline(self, user_id=None, screen_name=None, max_id=None,
since_id=None, max_pages=None):
"""
Returns a collection of the most recent tweets posted
by the user indicated by the user_id or screen_name parameter.
Provide a user_id or screen_name.
"""
... | python | def timeline(self, user_id=None, screen_name=None, max_id=None,
since_id=None, max_pages=None):
if user_id and screen_name:
raise ValueError('only user_id or screen_name may be passed')
# Strip if screen_name is prefixed with '@'
if screen_name:
screen_n... | [
"def",
"timeline",
"(",
"self",
",",
"user_id",
"=",
"None",
",",
"screen_name",
"=",
"None",
",",
"max_id",
"=",
"None",
",",
"since_id",
"=",
"None",
",",
"max_pages",
"=",
"None",
")",
":",
"if",
"user_id",
"and",
"screen_name",
":",
"raise",
"Value... | Returns a collection of the most recent tweets posted
by the user indicated by the user_id or screen_name parameter.
Provide a user_id or screen_name. | [
"Returns",
"a",
"collection",
"of",
"the",
"most",
"recent",
"tweets",
"posted",
"by",
"the",
"user",
"indicated",
"by",
"the",
"user_id",
"or",
"screen_name",
"parameter",
".",
"Provide",
"a",
"user_id",
"or",
"screen_name",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L138-L211 |
243,512 | DocNow/twarc | twarc/client.py | Twarc.follower_ids | def follower_ids(self, user):
"""
Returns Twitter user id lists for the specified user's followers.
A user can be a specific using their screen_name or user_id
"""
user = str(user)
user = user.lstrip('@')
url = 'https://api.twitter.com/1.1/followers/ids.json'
... | python | def follower_ids(self, user):
user = str(user)
user = user.lstrip('@')
url = 'https://api.twitter.com/1.1/followers/ids.json'
if re.match(r'^\d+$', user):
params = {'user_id': user, 'cursor': -1}
else:
params = {'screen_name': user, 'cursor': -1}
... | [
"def",
"follower_ids",
"(",
"self",
",",
"user",
")",
":",
"user",
"=",
"str",
"(",
"user",
")",
"user",
"=",
"user",
".",
"lstrip",
"(",
"'@'",
")",
"url",
"=",
"'https://api.twitter.com/1.1/followers/ids.json'",
"if",
"re",
".",
"match",
"(",
"r'^\\d+$'"... | Returns Twitter user id lists for the specified user's followers.
A user can be a specific using their screen_name or user_id | [
"Returns",
"Twitter",
"user",
"id",
"lists",
"for",
"the",
"specified",
"user",
"s",
"followers",
".",
"A",
"user",
"can",
"be",
"a",
"specific",
"using",
"their",
"screen_name",
"or",
"user_id"
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L254-L278 |
243,513 | DocNow/twarc | twarc/client.py | Twarc.filter | def filter(self, track=None, follow=None, locations=None, event=None,
record_keepalive=False):
"""
Returns an iterator for tweets that match a given filter track from
the livestream of tweets happening right now.
If a threading.Event is provided for event and the event is... | python | def filter(self, track=None, follow=None, locations=None, event=None,
record_keepalive=False):
if locations is not None:
if type(locations) == list:
locations = ','.join(locations)
locations = locations.replace('\\', '')
url = 'https://stream.twitt... | [
"def",
"filter",
"(",
"self",
",",
"track",
"=",
"None",
",",
"follow",
"=",
"None",
",",
"locations",
"=",
"None",
",",
"event",
"=",
"None",
",",
"record_keepalive",
"=",
"False",
")",
":",
"if",
"locations",
"is",
"not",
"None",
":",
"if",
"type",... | Returns an iterator for tweets that match a given filter track from
the livestream of tweets happening right now.
If a threading.Event is provided for event and the event is set,
the filter will be interrupted. | [
"Returns",
"an",
"iterator",
"for",
"tweets",
"that",
"match",
"a",
"given",
"filter",
"track",
"from",
"the",
"livestream",
"of",
"tweets",
"happening",
"right",
"now",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L308-L378 |
243,514 | DocNow/twarc | twarc/client.py | Twarc.sample | def sample(self, event=None, record_keepalive=False):
"""
Returns a small random sample of all public statuses. The Tweets
returned by the default access level are the same, so if two different
clients connect to this endpoint, they will see the same Tweets.
If a threading.Event... | python | def sample(self, event=None, record_keepalive=False):
url = 'https://stream.twitter.com/1.1/statuses/sample.json'
params = {"stall_warning": True}
headers = {'accept-encoding': 'deflate, gzip'}
errors = 0
while True:
try:
log.info("connecting to sample... | [
"def",
"sample",
"(",
"self",
",",
"event",
"=",
"None",
",",
"record_keepalive",
"=",
"False",
")",
":",
"url",
"=",
"'https://stream.twitter.com/1.1/statuses/sample.json'",
"params",
"=",
"{",
"\"stall_warning\"",
":",
"True",
"}",
"headers",
"=",
"{",
"'accep... | Returns a small random sample of all public statuses. The Tweets
returned by the default access level are the same, so if two different
clients connect to this endpoint, they will see the same Tweets.
If a threading.Event is provided for event and the event is set,
the sample will be in... | [
"Returns",
"a",
"small",
"random",
"sample",
"of",
"all",
"public",
"statuses",
".",
"The",
"Tweets",
"returned",
"by",
"the",
"default",
"access",
"level",
"are",
"the",
"same",
"so",
"if",
"two",
"different",
"clients",
"connect",
"to",
"this",
"endpoint",... | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L380-L436 |
243,515 | DocNow/twarc | twarc/client.py | Twarc.dehydrate | def dehydrate(self, iterator):
"""
Pass in an iterator of tweets' JSON and get back an iterator of the
IDs of each tweet.
"""
for line in iterator:
try:
yield json.loads(line)['id_str']
except Exception as e:
log.error("uhoh... | python | def dehydrate(self, iterator):
for line in iterator:
try:
yield json.loads(line)['id_str']
except Exception as e:
log.error("uhoh: %s\n" % e) | [
"def",
"dehydrate",
"(",
"self",
",",
"iterator",
")",
":",
"for",
"line",
"in",
"iterator",
":",
"try",
":",
"yield",
"json",
".",
"loads",
"(",
"line",
")",
"[",
"'id_str'",
"]",
"except",
"Exception",
"as",
"e",
":",
"log",
".",
"error",
"(",
"\... | Pass in an iterator of tweets' JSON and get back an iterator of the
IDs of each tweet. | [
"Pass",
"in",
"an",
"iterator",
"of",
"tweets",
"JSON",
"and",
"get",
"back",
"an",
"iterator",
"of",
"the",
"IDs",
"of",
"each",
"tweet",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L438-L447 |
243,516 | DocNow/twarc | twarc/client.py | Twarc.hydrate | def hydrate(self, iterator):
"""
Pass in an iterator of tweet ids and get back an iterator for the
decoded JSON for each corresponding tweet.
"""
ids = []
url = "https://api.twitter.com/1.1/statuses/lookup.json"
# lookup 100 tweets at a time
for tweet_id ... | python | def hydrate(self, iterator):
ids = []
url = "https://api.twitter.com/1.1/statuses/lookup.json"
# lookup 100 tweets at a time
for tweet_id in iterator:
tweet_id = str(tweet_id)
tweet_id = tweet_id.strip() # remove new line if present
ids.append(tweet_... | [
"def",
"hydrate",
"(",
"self",
",",
"iterator",
")",
":",
"ids",
"=",
"[",
"]",
"url",
"=",
"\"https://api.twitter.com/1.1/statuses/lookup.json\"",
"# lookup 100 tweets at a time",
"for",
"tweet_id",
"in",
"iterator",
":",
"tweet_id",
"=",
"str",
"(",
"tweet_id",
... | Pass in an iterator of tweet ids and get back an iterator for the
decoded JSON for each corresponding tweet. | [
"Pass",
"in",
"an",
"iterator",
"of",
"tweet",
"ids",
"and",
"get",
"back",
"an",
"iterator",
"for",
"the",
"decoded",
"JSON",
"for",
"each",
"corresponding",
"tweet",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L449-L482 |
243,517 | DocNow/twarc | twarc/client.py | Twarc.retweets | def retweets(self, tweet_id):
"""
Retrieves up to the last 100 retweets for the provided
tweet.
"""
log.info("retrieving retweets of %s", tweet_id)
url = "https://api.twitter.com/1.1/statuses/retweets/""{}.json".format(
tweet_id)
resp = self.get(u... | python | def retweets(self, tweet_id):
log.info("retrieving retweets of %s", tweet_id)
url = "https://api.twitter.com/1.1/statuses/retweets/""{}.json".format(
tweet_id)
resp = self.get(url, params={"count": 100})
for tweet in resp.json():
yield tweet | [
"def",
"retweets",
"(",
"self",
",",
"tweet_id",
")",
":",
"log",
".",
"info",
"(",
"\"retrieving retweets of %s\"",
",",
"tweet_id",
")",
"url",
"=",
"\"https://api.twitter.com/1.1/statuses/retweets/\"",
"\"{}.json\"",
".",
"format",
"(",
"tweet_id",
")",
"resp",
... | Retrieves up to the last 100 retweets for the provided
tweet. | [
"Retrieves",
"up",
"to",
"the",
"last",
"100",
"retweets",
"for",
"the",
"provided",
"tweet",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L490-L501 |
243,518 | DocNow/twarc | twarc/client.py | Twarc.trends_available | def trends_available(self):
"""
Returns a list of regions for which Twitter tracks trends.
"""
url = 'https://api.twitter.com/1.1/trends/available.json'
try:
resp = self.get(url)
except requests.exceptions.HTTPError as e:
raise e
return res... | python | def trends_available(self):
url = 'https://api.twitter.com/1.1/trends/available.json'
try:
resp = self.get(url)
except requests.exceptions.HTTPError as e:
raise e
return resp.json() | [
"def",
"trends_available",
"(",
"self",
")",
":",
"url",
"=",
"'https://api.twitter.com/1.1/trends/available.json'",
"try",
":",
"resp",
"=",
"self",
".",
"get",
"(",
"url",
")",
"except",
"requests",
".",
"exceptions",
".",
"HTTPError",
"as",
"e",
":",
"raise... | Returns a list of regions for which Twitter tracks trends. | [
"Returns",
"a",
"list",
"of",
"regions",
"for",
"which",
"Twitter",
"tracks",
"trends",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L503-L512 |
243,519 | DocNow/twarc | twarc/client.py | Twarc.trends_place | def trends_place(self, woeid, exclude=None):
"""
Returns recent Twitter trends for the specified WOEID. If
exclude == 'hashtags', Twitter will remove hashtag trends from the
response.
"""
url = 'https://api.twitter.com/1.1/trends/place.json'
params = {'id': woeid}... | python | def trends_place(self, woeid, exclude=None):
url = 'https://api.twitter.com/1.1/trends/place.json'
params = {'id': woeid}
if exclude:
params['exclude'] = exclude
try:
resp = self.get(url, params=params, allow_404=True)
except requests.exceptions.HTTPError ... | [
"def",
"trends_place",
"(",
"self",
",",
"woeid",
",",
"exclude",
"=",
"None",
")",
":",
"url",
"=",
"'https://api.twitter.com/1.1/trends/place.json'",
"params",
"=",
"{",
"'id'",
":",
"woeid",
"}",
"if",
"exclude",
":",
"params",
"[",
"'exclude'",
"]",
"=",... | Returns recent Twitter trends for the specified WOEID. If
exclude == 'hashtags', Twitter will remove hashtag trends from the
response. | [
"Returns",
"recent",
"Twitter",
"trends",
"for",
"the",
"specified",
"WOEID",
".",
"If",
"exclude",
"==",
"hashtags",
"Twitter",
"will",
"remove",
"hashtag",
"trends",
"from",
"the",
"response",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L514-L530 |
243,520 | DocNow/twarc | twarc/client.py | Twarc.replies | def replies(self, tweet, recursive=False, prune=()):
"""
replies returns a generator of tweets that are replies for a given
tweet. It includes the original tweet. If you would like to fetch the
replies to the replies use recursive=True which will do a depth-first
recursive walk o... | python | def replies(self, tweet, recursive=False, prune=()):
yield tweet
# get replies to the tweet
screen_name = tweet['user']['screen_name']
tweet_id = tweet['id_str']
log.info("looking for replies to: %s", tweet_id)
for reply in self.search("to:%s" % screen_name, since_id=twe... | [
"def",
"replies",
"(",
"self",
",",
"tweet",
",",
"recursive",
"=",
"False",
",",
"prune",
"=",
"(",
")",
")",
":",
"yield",
"tweet",
"# get replies to the tweet",
"screen_name",
"=",
"tweet",
"[",
"'user'",
"]",
"[",
"'screen_name'",
"]",
"tweet_id",
"=",... | replies returns a generator of tweets that are replies for a given
tweet. It includes the original tweet. If you would like to fetch the
replies to the replies use recursive=True which will do a depth-first
recursive walk of the replies. It also walk up the reply chain if you
supply a tw... | [
"replies",
"returns",
"a",
"generator",
"of",
"tweets",
"that",
"are",
"replies",
"for",
"a",
"given",
"tweet",
".",
"It",
"includes",
"the",
"original",
"tweet",
".",
"If",
"you",
"would",
"like",
"to",
"fetch",
"the",
"replies",
"to",
"the",
"replies",
... | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L544-L603 |
243,521 | DocNow/twarc | twarc/client.py | Twarc.list_members | def list_members(self, list_id=None, slug=None, owner_screen_name=None, owner_id=None):
"""
Returns the members of a list.
List id or (slug and (owner_screen_name or owner_id)) are required
"""
assert list_id or (slug and (owner_screen_name or owner_id))
url = 'https://a... | python | def list_members(self, list_id=None, slug=None, owner_screen_name=None, owner_id=None):
assert list_id or (slug and (owner_screen_name or owner_id))
url = 'https://api.twitter.com/1.1/lists/members.json'
params = {'cursor': -1}
if list_id:
params['list_id'] = list_id
... | [
"def",
"list_members",
"(",
"self",
",",
"list_id",
"=",
"None",
",",
"slug",
"=",
"None",
",",
"owner_screen_name",
"=",
"None",
",",
"owner_id",
"=",
"None",
")",
":",
"assert",
"list_id",
"or",
"(",
"slug",
"and",
"(",
"owner_screen_name",
"or",
"owne... | Returns the members of a list.
List id or (slug and (owner_screen_name or owner_id)) are required | [
"Returns",
"the",
"members",
"of",
"a",
"list",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L605-L634 |
243,522 | DocNow/twarc | twarc/client.py | Twarc.connect | def connect(self):
"""
Sets up the HTTP session to talk to Twitter. If one is active it is
closed and another one is opened.
"""
if not (self.consumer_key and self.consumer_secret and self.access_token
and self.access_token_secret):
raise RuntimeError(... | python | def connect(self):
if not (self.consumer_key and self.consumer_secret and self.access_token
and self.access_token_secret):
raise RuntimeError("MissingKeys")
if self.client:
log.info("closing existing http session")
self.client.close()
if self.... | [
"def",
"connect",
"(",
"self",
")",
":",
"if",
"not",
"(",
"self",
".",
"consumer_key",
"and",
"self",
".",
"consumer_secret",
"and",
"self",
".",
"access_token",
"and",
"self",
".",
"access_token_secret",
")",
":",
"raise",
"RuntimeError",
"(",
"\"MissingKe... | Sets up the HTTP session to talk to Twitter. If one is active it is
closed and another one is opened. | [
"Sets",
"up",
"the",
"HTTP",
"session",
"to",
"talk",
"to",
"Twitter",
".",
"If",
"one",
"is",
"active",
"it",
"is",
"closed",
"and",
"another",
"one",
"is",
"opened",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L707-L729 |
243,523 | DocNow/twarc | twarc/client.py | Twarc.get_keys | def get_keys(self):
"""
Get the Twitter API keys. Order of precedence is command line,
environment, config file. Return True if all the keys were found
and False if not.
"""
env = os.environ.get
if not self.consumer_key:
self.consumer_key = env('CONSUM... | python | def get_keys(self):
env = os.environ.get
if not self.consumer_key:
self.consumer_key = env('CONSUMER_KEY')
if not self.consumer_secret:
self.consumer_secret = env('CONSUMER_SECRET')
if not self.access_token:
self.access_token = env('ACCESS_TOKEN')
... | [
"def",
"get_keys",
"(",
"self",
")",
":",
"env",
"=",
"os",
".",
"environ",
".",
"get",
"if",
"not",
"self",
".",
"consumer_key",
":",
"self",
".",
"consumer_key",
"=",
"env",
"(",
"'CONSUMER_KEY'",
")",
"if",
"not",
"self",
".",
"consumer_secret",
":"... | Get the Twitter API keys. Order of precedence is command line,
environment, config file. Return True if all the keys were found
and False if not. | [
"Get",
"the",
"Twitter",
"API",
"keys",
".",
"Order",
"of",
"precedence",
"is",
"command",
"line",
"environment",
"config",
"file",
".",
"Return",
"True",
"if",
"all",
"the",
"keys",
"were",
"found",
"and",
"False",
"if",
"not",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L731-L751 |
243,524 | DocNow/twarc | twarc/client.py | Twarc.validate_keys | def validate_keys(self):
"""
Validate the keys provided are authentic credentials.
"""
url = 'https://api.twitter.com/1.1/account/verify_credentials.json'
keys_present = self.consumer_key and self.consumer_secret and \
self.access_token and self.access_tok... | python | def validate_keys(self):
url = 'https://api.twitter.com/1.1/account/verify_credentials.json'
keys_present = self.consumer_key and self.consumer_secret and \
self.access_token and self.access_token_secret
if keys_present:
try:
# Need to explici... | [
"def",
"validate_keys",
"(",
"self",
")",
":",
"url",
"=",
"'https://api.twitter.com/1.1/account/verify_credentials.json'",
"keys_present",
"=",
"self",
".",
"consumer_key",
"and",
"self",
".",
"consumer_secret",
"and",
"self",
".",
"access_token",
"and",
"self",
".",... | Validate the keys provided are authentic credentials. | [
"Validate",
"the",
"keys",
"provided",
"are",
"authentic",
"credentials",
"."
] | 47dd87d0c00592a4d583412c9d660ba574fc6f26 | https://github.com/DocNow/twarc/blob/47dd87d0c00592a4d583412c9d660ba574fc6f26/twarc/client.py#L753-L774 |
243,525 | rochacbruno/dynaconf | dynaconf/contrib/flask_dynaconf.py | FlaskDynaconf.init_app | def init_app(self, app, **kwargs):
"""kwargs holds initial dynaconf configuration"""
self.kwargs.update(kwargs)
self.settings = self.dynaconf_instance or LazySettings(**self.kwargs)
app.config = self.make_config(app)
app.dynaconf = self.settings | python | def init_app(self, app, **kwargs):
self.kwargs.update(kwargs)
self.settings = self.dynaconf_instance or LazySettings(**self.kwargs)
app.config = self.make_config(app)
app.dynaconf = self.settings | [
"def",
"init_app",
"(",
"self",
",",
"app",
",",
"*",
"*",
"kwargs",
")",
":",
"self",
".",
"kwargs",
".",
"update",
"(",
"kwargs",
")",
"self",
".",
"settings",
"=",
"self",
".",
"dynaconf_instance",
"or",
"LazySettings",
"(",
"*",
"*",
"self",
".",... | kwargs holds initial dynaconf configuration | [
"kwargs",
"holds",
"initial",
"dynaconf",
"configuration"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/contrib/flask_dynaconf.py#L102-L107 |
243,526 | rochacbruno/dynaconf | dynaconf/contrib/flask_dynaconf.py | DynaconfConfig.get | def get(self, key, default=None):
"""Gets config from dynaconf variables
if variables does not exists in dynaconf try getting from
`app.config` to support runtime settings."""
return self._settings.get(key, Config.get(self, key, default)) | python | def get(self, key, default=None):
return self._settings.get(key, Config.get(self, key, default)) | [
"def",
"get",
"(",
"self",
",",
"key",
",",
"default",
"=",
"None",
")",
":",
"return",
"self",
".",
"_settings",
".",
"get",
"(",
"key",
",",
"Config",
".",
"get",
"(",
"self",
",",
"key",
",",
"default",
")",
")"
] | Gets config from dynaconf variables
if variables does not exists in dynaconf try getting from
`app.config` to support runtime settings. | [
"Gets",
"config",
"from",
"dynaconf",
"variables",
"if",
"variables",
"does",
"not",
"exists",
"in",
"dynaconf",
"try",
"getting",
"from",
"app",
".",
"config",
"to",
"support",
"runtime",
"settings",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/contrib/flask_dynaconf.py#L130-L134 |
243,527 | rochacbruno/dynaconf | dynaconf/utils/__init__.py | object_merge | def object_merge(old, new, unique=False):
"""
Recursively merge two data structures.
:param unique: When set to True existing list items are not set.
"""
if isinstance(old, list) and isinstance(new, list):
if old == new:
return
for item in old[::-1]:
if uniqu... | python | def object_merge(old, new, unique=False):
if isinstance(old, list) and isinstance(new, list):
if old == new:
return
for item in old[::-1]:
if unique and item in new:
continue
new.insert(0, item)
if isinstance(old, dict) and isinstance(new, dict... | [
"def",
"object_merge",
"(",
"old",
",",
"new",
",",
"unique",
"=",
"False",
")",
":",
"if",
"isinstance",
"(",
"old",
",",
"list",
")",
"and",
"isinstance",
"(",
"new",
",",
"list",
")",
":",
"if",
"old",
"==",
"new",
":",
"return",
"for",
"item",
... | Recursively merge two data structures.
:param unique: When set to True existing list items are not set. | [
"Recursively",
"merge",
"two",
"data",
"structures",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/utils/__init__.py#L20-L38 |
243,528 | rochacbruno/dynaconf | dynaconf/utils/__init__.py | compat_kwargs | def compat_kwargs(kwargs):
"""To keep backwards compat change the kwargs to new names"""
warn_deprecations(kwargs)
for old, new in RENAMED_VARS.items():
if old in kwargs:
kwargs[new] = kwargs[old]
# update cross references
for c_old, c_new in RENAMED_VARS.items():... | python | def compat_kwargs(kwargs):
warn_deprecations(kwargs)
for old, new in RENAMED_VARS.items():
if old in kwargs:
kwargs[new] = kwargs[old]
# update cross references
for c_old, c_new in RENAMED_VARS.items():
if c_new == new:
kwargs[c_old... | [
"def",
"compat_kwargs",
"(",
"kwargs",
")",
":",
"warn_deprecations",
"(",
"kwargs",
")",
"for",
"old",
",",
"new",
"in",
"RENAMED_VARS",
".",
"items",
"(",
")",
":",
"if",
"old",
"in",
"kwargs",
":",
"kwargs",
"[",
"new",
"]",
"=",
"kwargs",
"[",
"o... | To keep backwards compat change the kwargs to new names | [
"To",
"keep",
"backwards",
"compat",
"change",
"the",
"kwargs",
"to",
"new",
"names"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/utils/__init__.py#L107-L116 |
243,529 | rochacbruno/dynaconf | dynaconf/utils/__init__.py | deduplicate | def deduplicate(list_object):
"""Rebuild `list_object` removing duplicated and keeping order"""
new = []
for item in list_object:
if item not in new:
new.append(item)
return new | python | def deduplicate(list_object):
new = []
for item in list_object:
if item not in new:
new.append(item)
return new | [
"def",
"deduplicate",
"(",
"list_object",
")",
":",
"new",
"=",
"[",
"]",
"for",
"item",
"in",
"list_object",
":",
"if",
"item",
"not",
"in",
"new",
":",
"new",
".",
"append",
"(",
"item",
")",
"return",
"new"
] | Rebuild `list_object` removing duplicated and keeping order | [
"Rebuild",
"list_object",
"removing",
"duplicated",
"and",
"keeping",
"order"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/utils/__init__.py#L148-L154 |
243,530 | rochacbruno/dynaconf | dynaconf/utils/__init__.py | trimmed_split | def trimmed_split(s, seps=(";", ",")):
"""Given a string s, split is by one of one of the seps."""
for sep in seps:
if sep not in s:
continue
data = [item.strip() for item in s.strip().split(sep)]
return data
return [s] | python | def trimmed_split(s, seps=(";", ",")):
for sep in seps:
if sep not in s:
continue
data = [item.strip() for item in s.strip().split(sep)]
return data
return [s] | [
"def",
"trimmed_split",
"(",
"s",
",",
"seps",
"=",
"(",
"\";\"",
",",
"\",\"",
")",
")",
":",
"for",
"sep",
"in",
"seps",
":",
"if",
"sep",
"not",
"in",
"s",
":",
"continue",
"data",
"=",
"[",
"item",
".",
"strip",
"(",
")",
"for",
"item",
"in... | Given a string s, split is by one of one of the seps. | [
"Given",
"a",
"string",
"s",
"split",
"is",
"by",
"one",
"of",
"one",
"of",
"the",
"seps",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/utils/__init__.py#L175-L182 |
243,531 | rochacbruno/dynaconf | dynaconf/utils/__init__.py | ensure_a_list | def ensure_a_list(data):
"""Ensure data is a list or wrap it in a list"""
if not data:
return []
if isinstance(data, (list, tuple, set)):
return list(data)
if isinstance(data, str):
data = trimmed_split(data) # settings.toml,other.yaml
return data
return [data] | python | def ensure_a_list(data):
if not data:
return []
if isinstance(data, (list, tuple, set)):
return list(data)
if isinstance(data, str):
data = trimmed_split(data) # settings.toml,other.yaml
return data
return [data] | [
"def",
"ensure_a_list",
"(",
"data",
")",
":",
"if",
"not",
"data",
":",
"return",
"[",
"]",
"if",
"isinstance",
"(",
"data",
",",
"(",
"list",
",",
"tuple",
",",
"set",
")",
")",
":",
"return",
"list",
"(",
"data",
")",
"if",
"isinstance",
"(",
... | Ensure data is a list or wrap it in a list | [
"Ensure",
"data",
"is",
"a",
"list",
"or",
"wrap",
"it",
"in",
"a",
"list"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/utils/__init__.py#L185-L194 |
243,532 | rochacbruno/dynaconf | dynaconf/loaders/redis_loader.py | load | def load(obj, env=None, silent=True, key=None):
"""Reads and loads in to "settings" a single key or all keys from redis
:param obj: the settings instance
:param env: settings env default='DYNACONF'
:param silent: if errors should raise
:param key: if defined load a single key, else load all in env
... | python | def load(obj, env=None, silent=True, key=None):
redis = StrictRedis(**obj.get("REDIS_FOR_DYNACONF"))
holder = obj.get("ENVVAR_PREFIX_FOR_DYNACONF")
try:
if key:
value = redis.hget(holder.upper(), key)
if value:
obj.logger.debug(
"redis_load... | [
"def",
"load",
"(",
"obj",
",",
"env",
"=",
"None",
",",
"silent",
"=",
"True",
",",
"key",
"=",
"None",
")",
":",
"redis",
"=",
"StrictRedis",
"(",
"*",
"*",
"obj",
".",
"get",
"(",
"\"REDIS_FOR_DYNACONF\"",
")",
")",
"holder",
"=",
"obj",
".",
... | Reads and loads in to "settings" a single key or all keys from redis
:param obj: the settings instance
:param env: settings env default='DYNACONF'
:param silent: if errors should raise
:param key: if defined load a single key, else load all in env
:return: None | [
"Reads",
"and",
"loads",
"in",
"to",
"settings",
"a",
"single",
"key",
"or",
"all",
"keys",
"from",
"redis"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/loaders/redis_loader.py#L16-L60 |
243,533 | rochacbruno/dynaconf | dynaconf/loaders/py_loader.py | load | def load(obj, settings_module, identifier="py", silent=False, key=None):
"""Tries to import a python module"""
mod, loaded_from = get_module(obj, settings_module, silent)
if mod and loaded_from:
obj.logger.debug("py_loader: {}".format(mod))
else:
obj.logger.debug(
"py_loader... | python | def load(obj, settings_module, identifier="py", silent=False, key=None):
mod, loaded_from = get_module(obj, settings_module, silent)
if mod and loaded_from:
obj.logger.debug("py_loader: {}".format(mod))
else:
obj.logger.debug(
"py_loader: %s (Ignoring, Not Found)", settings_modu... | [
"def",
"load",
"(",
"obj",
",",
"settings_module",
",",
"identifier",
"=",
"\"py\"",
",",
"silent",
"=",
"False",
",",
"key",
"=",
"None",
")",
":",
"mod",
",",
"loaded_from",
"=",
"get_module",
"(",
"obj",
",",
"settings_module",
",",
"silent",
")",
"... | Tries to import a python module | [
"Tries",
"to",
"import",
"a",
"python",
"module"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/loaders/py_loader.py#L15-L39 |
243,534 | rochacbruno/dynaconf | dynaconf/loaders/py_loader.py | import_from_filename | def import_from_filename(obj, filename, silent=False): # pragma: no cover
"""If settings_module is a filename path import it."""
if filename in [item.filename for item in inspect.stack()]:
raise ImportError(
"Looks like you are loading dynaconf "
"from inside the {} file and the... | python | def import_from_filename(obj, filename, silent=False): # pragma: no cover
if filename in [item.filename for item in inspect.stack()]:
raise ImportError(
"Looks like you are loading dynaconf "
"from inside the {} file and then it is trying "
"to load itself entering in a ... | [
"def",
"import_from_filename",
"(",
"obj",
",",
"filename",
",",
"silent",
"=",
"False",
")",
":",
"# pragma: no cover",
"if",
"filename",
"in",
"[",
"item",
".",
"filename",
"for",
"item",
"in",
"inspect",
".",
"stack",
"(",
")",
"]",
":",
"raise",
"Imp... | If settings_module is a filename path import it. | [
"If",
"settings_module",
"is",
"a",
"filename",
"path",
"import",
"it",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/loaders/py_loader.py#L58-L94 |
243,535 | rochacbruno/dynaconf | dynaconf/loaders/vault_loader.py | _get_env_list | def _get_env_list(obj, env):
"""Creates the list of environments to read
:param obj: the settings instance
:param env: settings env default='DYNACONF'
:return: a list of working environments
"""
# add the [default] env
env_list = [obj.get("DEFAULT_ENV_FOR_DYNACONF")]
# compatibility wit... | python | def _get_env_list(obj, env):
# add the [default] env
env_list = [obj.get("DEFAULT_ENV_FOR_DYNACONF")]
# compatibility with older versions that still uses [dynaconf] as
# [default] env
global_env = obj.get("ENVVAR_PREFIX_FOR_DYNACONF") or "DYNACONF"
if global_env not in env_list:
env_list... | [
"def",
"_get_env_list",
"(",
"obj",
",",
"env",
")",
":",
"# add the [default] env",
"env_list",
"=",
"[",
"obj",
".",
"get",
"(",
"\"DEFAULT_ENV_FOR_DYNACONF\"",
")",
"]",
"# compatibility with older versions that still uses [dynaconf] as",
"# [default] env",
"global_env",... | Creates the list of environments to read
:param obj: the settings instance
:param env: settings env default='DYNACONF'
:return: a list of working environments | [
"Creates",
"the",
"list",
"of",
"environments",
"to",
"read"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/loaders/vault_loader.py#L18-L40 |
243,536 | rochacbruno/dynaconf | dynaconf/loaders/vault_loader.py | load | def load(obj, env=None, silent=None, key=None):
"""Reads and loads in to "settings" a single key or all keys from vault
:param obj: the settings instance
:param env: settings env default='DYNACONF'
:param silent: if errors should raise
:param key: if defined load a single key, else load all in env
... | python | def load(obj, env=None, silent=None, key=None):
client = get_client(obj)
env_list = _get_env_list(obj, env)
for env in env_list:
path = "/".join([obj.VAULT_PATH_FOR_DYNACONF, env]).replace("//", "/")
data = client.read(path)
if data:
# There seems to be a data dict within... | [
"def",
"load",
"(",
"obj",
",",
"env",
"=",
"None",
",",
"silent",
"=",
"None",
",",
"key",
"=",
"None",
")",
":",
"client",
"=",
"get_client",
"(",
"obj",
")",
"env_list",
"=",
"_get_env_list",
"(",
"obj",
",",
"env",
")",
"for",
"env",
"in",
"e... | Reads and loads in to "settings" a single key or all keys from vault
:param obj: the settings instance
:param env: settings env default='DYNACONF'
:param silent: if errors should raise
:param key: if defined load a single key, else load all in env
:return: None | [
"Reads",
"and",
"loads",
"in",
"to",
"settings",
"a",
"single",
"key",
"or",
"all",
"keys",
"from",
"vault"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/loaders/vault_loader.py#L53-L97 |
243,537 | rochacbruno/dynaconf | dynaconf/cli.py | set_settings | def set_settings(instance=None):
"""Pick correct settings instance and set it to a global variable."""
global settings
settings = None
if instance:
settings = import_settings(instance)
elif "INSTANCE_FOR_DYNACONF" in os.environ:
settings = import_settings(os.environ["INSTANCE_FOR... | python | def set_settings(instance=None):
global settings
settings = None
if instance:
settings = import_settings(instance)
elif "INSTANCE_FOR_DYNACONF" in os.environ:
settings = import_settings(os.environ["INSTANCE_FOR_DYNACONF"])
elif "FLASK_APP" in os.environ: # pragma: no cover
... | [
"def",
"set_settings",
"(",
"instance",
"=",
"None",
")",
":",
"global",
"settings",
"settings",
"=",
"None",
"if",
"instance",
":",
"settings",
"=",
"import_settings",
"(",
"instance",
")",
"elif",
"\"INSTANCE_FOR_DYNACONF\"",
"in",
"os",
".",
"environ",
":",... | Pick correct settings instance and set it to a global variable. | [
"Pick",
"correct",
"settings",
"instance",
"and",
"set",
"it",
"to",
"a",
"global",
"variable",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/cli.py#L33-L81 |
243,538 | rochacbruno/dynaconf | dynaconf/cli.py | import_settings | def import_settings(dotted_path):
"""Import settings instance from python dotted path.
Last item in dotted path must be settings instace.
Example: import_settings('path.to.settings')
"""
if "." in dotted_path:
module, name = dotted_path.rsplit(".", 1)
else:
raise click.UsageErr... | python | def import_settings(dotted_path):
if "." in dotted_path:
module, name = dotted_path.rsplit(".", 1)
else:
raise click.UsageError(
"invalid path to settings instance: {}".format(dotted_path)
)
try:
module = importlib.import_module(module)
except ImportError as e... | [
"def",
"import_settings",
"(",
"dotted_path",
")",
":",
"if",
"\".\"",
"in",
"dotted_path",
":",
"module",
",",
"name",
"=",
"dotted_path",
".",
"rsplit",
"(",
"\".\"",
",",
"1",
")",
"else",
":",
"raise",
"click",
".",
"UsageError",
"(",
"\"invalid path t... | Import settings instance from python dotted path.
Last item in dotted path must be settings instace.
Example: import_settings('path.to.settings') | [
"Import",
"settings",
"instance",
"from",
"python",
"dotted",
"path",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/cli.py#L84-L104 |
243,539 | rochacbruno/dynaconf | dynaconf/cli.py | read_file_in_root_directory | def read_file_in_root_directory(*names, **kwargs):
"""Read a file on root dir."""
return read_file(
os.path.join(os.path.dirname(__file__), *names),
encoding=kwargs.get("encoding", "utf-8"),
) | python | def read_file_in_root_directory(*names, **kwargs):
return read_file(
os.path.join(os.path.dirname(__file__), *names),
encoding=kwargs.get("encoding", "utf-8"),
) | [
"def",
"read_file_in_root_directory",
"(",
"*",
"names",
",",
"*",
"*",
"kwargs",
")",
":",
"return",
"read_file",
"(",
"os",
".",
"path",
".",
"join",
"(",
"os",
".",
"path",
".",
"dirname",
"(",
"__file__",
")",
",",
"*",
"names",
")",
",",
"encodi... | Read a file on root dir. | [
"Read",
"a",
"file",
"on",
"root",
"dir",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/cli.py#L119-L124 |
243,540 | rochacbruno/dynaconf | dynaconf/cli.py | show_banner | def show_banner(ctx, param, value):
"""Shows dynaconf awesome banner"""
if not value or ctx.resilient_parsing:
return
set_settings()
click.echo(settings.dynaconf_banner)
click.echo("Learn more at: http://github.com/rochacbruno/dynaconf")
ctx.exit() | python | def show_banner(ctx, param, value):
if not value or ctx.resilient_parsing:
return
set_settings()
click.echo(settings.dynaconf_banner)
click.echo("Learn more at: http://github.com/rochacbruno/dynaconf")
ctx.exit() | [
"def",
"show_banner",
"(",
"ctx",
",",
"param",
",",
"value",
")",
":",
"if",
"not",
"value",
"or",
"ctx",
".",
"resilient_parsing",
":",
"return",
"set_settings",
"(",
")",
"click",
".",
"echo",
"(",
"settings",
".",
"dynaconf_banner",
")",
"click",
"."... | Shows dynaconf awesome banner | [
"Shows",
"dynaconf",
"awesome",
"banner"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/cli.py#L143-L150 |
243,541 | rochacbruno/dynaconf | dynaconf/cli.py | write | def write(to, _vars, _secrets, path, env, y):
"""Writes data to specific source"""
_vars = split_vars(_vars)
_secrets = split_vars(_secrets)
loader = importlib.import_module("dynaconf.loaders.{}_loader".format(to))
if to in EXTS:
# Lets write to a file
path = Path(path)
if... | python | def write(to, _vars, _secrets, path, env, y):
_vars = split_vars(_vars)
_secrets = split_vars(_secrets)
loader = importlib.import_module("dynaconf.loaders.{}_loader".format(to))
if to in EXTS:
# Lets write to a file
path = Path(path)
if str(path).endswith(constants.ALL_EXTENSI... | [
"def",
"write",
"(",
"to",
",",
"_vars",
",",
"_secrets",
",",
"path",
",",
"env",
",",
"y",
")",
":",
"_vars",
"=",
"split_vars",
"(",
"_vars",
")",
"_secrets",
"=",
"split_vars",
"(",
"_secrets",
")",
"loader",
"=",
"importlib",
".",
"import_module",... | Writes data to specific source | [
"Writes",
"data",
"to",
"specific",
"source"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/cli.py#L496-L562 |
243,542 | rochacbruno/dynaconf | dynaconf/cli.py | validate | def validate(path): # pragma: no cover
"""Validates Dynaconf settings based on rules defined in
dynaconf_validators.toml"""
# reads the 'dynaconf_validators.toml' from path
# for each section register the validator for specific env
# call validate
path = Path(path)
if not str(path).endswi... | python | def validate(path): # pragma: no cover
# reads the 'dynaconf_validators.toml' from path
# for each section register the validator for specific env
# call validate
path = Path(path)
if not str(path).endswith(".toml"):
path = path / "dynaconf_validators.toml"
if not path.exists(): # p... | [
"def",
"validate",
"(",
"path",
")",
":",
"# pragma: no cover",
"# reads the 'dynaconf_validators.toml' from path",
"# for each section register the validator for specific env",
"# call validate",
"path",
"=",
"Path",
"(",
"path",
")",
"if",
"not",
"str",
"(",
"path",
")",
... | Validates Dynaconf settings based on rules defined in
dynaconf_validators.toml | [
"Validates",
"Dynaconf",
"settings",
"based",
"on",
"rules",
"defined",
"in",
"dynaconf_validators",
".",
"toml"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/cli.py#L569-L620 |
243,543 | rochacbruno/dynaconf | example/common/program.py | connect | def connect(server, port, username, password):
"""This function might be something coming from your ORM"""
print("-" * 79)
print("Connecting to: {}".format(server))
print("At port: {}".format(port))
print("Using username: {}".format(username))
print("Using password: {}".format(password))
pri... | python | def connect(server, port, username, password):
print("-" * 79)
print("Connecting to: {}".format(server))
print("At port: {}".format(port))
print("Using username: {}".format(username))
print("Using password: {}".format(password))
print("-" * 79) | [
"def",
"connect",
"(",
"server",
",",
"port",
",",
"username",
",",
"password",
")",
":",
"print",
"(",
"\"-\"",
"*",
"79",
")",
"print",
"(",
"\"Connecting to: {}\"",
".",
"format",
"(",
"server",
")",
")",
"print",
"(",
"\"At port: {}\"",
".",
"format"... | This function might be something coming from your ORM | [
"This",
"function",
"might",
"be",
"something",
"coming",
"from",
"your",
"ORM"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/example/common/program.py#L4-L11 |
243,544 | rochacbruno/dynaconf | dynaconf/loaders/env_loader.py | write | def write(settings_path, settings_data, **kwargs):
"""Write data to .env file"""
for key, value in settings_data.items():
dotenv_cli.set_key(str(settings_path), key.upper(), str(value)) | python | def write(settings_path, settings_data, **kwargs):
for key, value in settings_data.items():
dotenv_cli.set_key(str(settings_path), key.upper(), str(value)) | [
"def",
"write",
"(",
"settings_path",
",",
"settings_data",
",",
"*",
"*",
"kwargs",
")",
":",
"for",
"key",
",",
"value",
"in",
"settings_data",
".",
"items",
"(",
")",
":",
"dotenv_cli",
".",
"set_key",
"(",
"str",
"(",
"settings_path",
")",
",",
"ke... | Write data to .env file | [
"Write",
"data",
"to",
".",
"env",
"file"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/loaders/env_loader.py#L60-L63 |
243,545 | rochacbruno/dynaconf | dynaconf/utils/parse_conf.py | parse_with_toml | def parse_with_toml(data):
"""Uses TOML syntax to parse data"""
try:
return toml.loads("key={}".format(data), DynaBox).key
except toml.TomlDecodeError:
return data | python | def parse_with_toml(data):
try:
return toml.loads("key={}".format(data), DynaBox).key
except toml.TomlDecodeError:
return data | [
"def",
"parse_with_toml",
"(",
"data",
")",
":",
"try",
":",
"return",
"toml",
".",
"loads",
"(",
"\"key={}\"",
".",
"format",
"(",
"data",
")",
",",
"DynaBox",
")",
".",
"key",
"except",
"toml",
".",
"TomlDecodeError",
":",
"return",
"data"
] | Uses TOML syntax to parse data | [
"Uses",
"TOML",
"syntax",
"to",
"parse",
"data"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/utils/parse_conf.py#L28-L33 |
243,546 | rochacbruno/dynaconf | dynaconf/loaders/base.py | BaseLoader.load | def load(self, filename=None, key=None, silent=True):
"""
Reads and loads in to `self.obj` a single key or all keys from source
:param filename: Optional filename to load
:param key: if provided load a single key
:param silent: if load erros should be silenced
"""
... | python | def load(self, filename=None, key=None, silent=True):
filename = filename or self.obj.get(self.identifier.upper())
if not filename:
return
if not isinstance(filename, (list, tuple)):
split_files = ensure_a_list(filename)
if all([f.endswith(self.extensions) fo... | [
"def",
"load",
"(",
"self",
",",
"filename",
"=",
"None",
",",
"key",
"=",
"None",
",",
"silent",
"=",
"True",
")",
":",
"filename",
"=",
"filename",
"or",
"self",
".",
"obj",
".",
"get",
"(",
"self",
".",
"identifier",
".",
"upper",
"(",
")",
")... | Reads and loads in to `self.obj` a single key or all keys from source
:param filename: Optional filename to load
:param key: if provided load a single key
:param silent: if load erros should be silenced | [
"Reads",
"and",
"loads",
"in",
"to",
"self",
".",
"obj",
"a",
"single",
"key",
"or",
"all",
"keys",
"from",
"source"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/loaders/base.py#L44-L84 |
243,547 | rochacbruno/dynaconf | dynaconf/base.py | LazySettings._setup | def _setup(self):
"""Initial setup, run once."""
default_settings.reload()
environment_variable = self._kwargs.get(
"ENVVAR_FOR_DYNACONF", default_settings.ENVVAR_FOR_DYNACONF
)
settings_module = os.environ.get(environment_variable)
self._wrapped = Settings(
... | python | def _setup(self):
default_settings.reload()
environment_variable = self._kwargs.get(
"ENVVAR_FOR_DYNACONF", default_settings.ENVVAR_FOR_DYNACONF
)
settings_module = os.environ.get(environment_variable)
self._wrapped = Settings(
settings_module=settings_mod... | [
"def",
"_setup",
"(",
"self",
")",
":",
"default_settings",
".",
"reload",
"(",
")",
"environment_variable",
"=",
"self",
".",
"_kwargs",
".",
"get",
"(",
"\"ENVVAR_FOR_DYNACONF\"",
",",
"default_settings",
".",
"ENVVAR_FOR_DYNACONF",
")",
"settings_module",
"=",
... | Initial setup, run once. | [
"Initial",
"setup",
"run",
"once",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L115-L125 |
243,548 | rochacbruno/dynaconf | dynaconf/base.py | LazySettings.configure | def configure(self, settings_module=None, **kwargs):
"""
Allows user to reconfigure settings object passing a new settings
module or separated kwargs
:param settings_module: defines the setttings file
:param kwargs: override default settings
"""
default_settings... | python | def configure(self, settings_module=None, **kwargs):
default_settings.reload()
environment_var = self._kwargs.get(
"ENVVAR_FOR_DYNACONF", default_settings.ENVVAR_FOR_DYNACONF
)
settings_module = settings_module or os.environ.get(environment_var)
compat_kwargs(kwargs)
... | [
"def",
"configure",
"(",
"self",
",",
"settings_module",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"default_settings",
".",
"reload",
"(",
")",
"environment_var",
"=",
"self",
".",
"_kwargs",
".",
"get",
"(",
"\"ENVVAR_FOR_DYNACONF\"",
",",
"default_se... | Allows user to reconfigure settings object passing a new settings
module or separated kwargs
:param settings_module: defines the setttings file
:param kwargs: override default settings | [
"Allows",
"user",
"to",
"reconfigure",
"settings",
"object",
"passing",
"a",
"new",
"settings",
"module",
"or",
"separated",
"kwargs"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L127-L143 |
243,549 | rochacbruno/dynaconf | dynaconf/base.py | Settings.as_dict | def as_dict(self, env=None, internal=False):
"""Returns a dictionary with set key and values.
:param env: Str env name, default self.current_env `DEVELOPMENT`
:param internal: bool - should include dynaconf internal vars?
"""
ctx_mgr = suppress() if env is None else self.using_e... | python | def as_dict(self, env=None, internal=False):
ctx_mgr = suppress() if env is None else self.using_env(env)
with ctx_mgr:
data = self.store.copy()
# if not internal remove internal settings
if not internal:
for name in dir(default_settings):
... | [
"def",
"as_dict",
"(",
"self",
",",
"env",
"=",
"None",
",",
"internal",
"=",
"False",
")",
":",
"ctx_mgr",
"=",
"suppress",
"(",
")",
"if",
"env",
"is",
"None",
"else",
"self",
".",
"using_env",
"(",
"env",
")",
"with",
"ctx_mgr",
":",
"data",
"="... | Returns a dictionary with set key and values.
:param env: Str env name, default self.current_env `DEVELOPMENT`
:param internal: bool - should include dynaconf internal vars? | [
"Returns",
"a",
"dictionary",
"with",
"set",
"key",
"and",
"values",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L237-L250 |
243,550 | rochacbruno/dynaconf | dynaconf/base.py | Settings._dotted_get | def _dotted_get(self, dotted_key, default=None, **kwargs):
"""
Perform dotted key lookups and keep track of where we are.
"""
split_key = dotted_key.split(".")
name, keys = split_key[0], split_key[1:]
result = self.get(name, default=default, **kwargs)
self._memoiz... | python | def _dotted_get(self, dotted_key, default=None, **kwargs):
split_key = dotted_key.split(".")
name, keys = split_key[0], split_key[1:]
result = self.get(name, default=default, **kwargs)
self._memoized = result
# If we've reached the end, then return result and clear the
#... | [
"def",
"_dotted_get",
"(",
"self",
",",
"dotted_key",
",",
"default",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"split_key",
"=",
"dotted_key",
".",
"split",
"(",
"\".\"",
")",
"name",
",",
"keys",
"=",
"split_key",
"[",
"0",
"]",
",",
"split_k... | Perform dotted key lookups and keep track of where we are. | [
"Perform",
"dotted",
"key",
"lookups",
"and",
"keep",
"track",
"of",
"where",
"we",
"are",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L252-L268 |
243,551 | rochacbruno/dynaconf | dynaconf/base.py | Settings.exists | def exists(self, key, fresh=False):
"""Check if key exists
:param key: the name of setting variable
:param fresh: if key should be taken from source direclty
:return: Boolean
"""
key = key.upper()
if key in self._deleted:
return False
return s... | python | def exists(self, key, fresh=False):
key = key.upper()
if key in self._deleted:
return False
return self.get(key, fresh=fresh, default=missing) is not missing | [
"def",
"exists",
"(",
"self",
",",
"key",
",",
"fresh",
"=",
"False",
")",
":",
"key",
"=",
"key",
".",
"upper",
"(",
")",
"if",
"key",
"in",
"self",
".",
"_deleted",
":",
"return",
"False",
"return",
"self",
".",
"get",
"(",
"key",
",",
"fresh",... | Check if key exists
:param key: the name of setting variable
:param fresh: if key should be taken from source direclty
:return: Boolean | [
"Check",
"if",
"key",
"exists"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L310-L320 |
243,552 | rochacbruno/dynaconf | dynaconf/base.py | Settings.get_environ | def get_environ(self, key, default=None, cast=None):
"""Get value from environment variable using os.environ.get
:param key: The name of the setting value, will always be upper case
:param default: In case of not found it will be returned
:param cast: Should cast in to @int, @float, @bo... | python | def get_environ(self, key, default=None, cast=None):
key = key.upper()
data = self.environ.get(key, default)
if data:
if cast in converters:
data = converters.get(cast)(data)
if cast is True:
data = parse_conf_data(data, tomlfy=True)
... | [
"def",
"get_environ",
"(",
"self",
",",
"key",
",",
"default",
"=",
"None",
",",
"cast",
"=",
"None",
")",
":",
"key",
"=",
"key",
".",
"upper",
"(",
")",
"data",
"=",
"self",
".",
"environ",
".",
"get",
"(",
"key",
",",
"default",
")",
"if",
"... | Get value from environment variable using os.environ.get
:param key: The name of the setting value, will always be upper case
:param default: In case of not found it will be returned
:param cast: Should cast in to @int, @float, @bool or @json ?
or cast must be true to use cast inferenc... | [
"Get",
"value",
"from",
"environment",
"variable",
"using",
"os",
".",
"environ",
".",
"get"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L333-L349 |
243,553 | rochacbruno/dynaconf | dynaconf/base.py | Settings.settings_module | def settings_module(self):
"""Gets SETTINGS_MODULE variable"""
settings_module = parse_conf_data(
os.environ.get(
self.ENVVAR_FOR_DYNACONF, self.SETTINGS_FILE_FOR_DYNACONF
),
tomlfy=True,
)
if settings_module != getattr(self, "SETTINGS_... | python | def settings_module(self):
settings_module = parse_conf_data(
os.environ.get(
self.ENVVAR_FOR_DYNACONF, self.SETTINGS_FILE_FOR_DYNACONF
),
tomlfy=True,
)
if settings_module != getattr(self, "SETTINGS_MODULE", None):
self.set("SETTIN... | [
"def",
"settings_module",
"(",
"self",
")",
":",
"settings_module",
"=",
"parse_conf_data",
"(",
"os",
".",
"environ",
".",
"get",
"(",
"self",
".",
"ENVVAR_FOR_DYNACONF",
",",
"self",
".",
"SETTINGS_FILE_FOR_DYNACONF",
")",
",",
"tomlfy",
"=",
"True",
",",
... | Gets SETTINGS_MODULE variable | [
"Gets",
"SETTINGS_MODULE",
"variable"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L472-L482 |
243,554 | rochacbruno/dynaconf | dynaconf/base.py | Settings.clean | def clean(self, *args, **kwargs):
"""Clean all loaded values to reload when switching envs"""
for key in list(self.store.keys()):
self.unset(key) | python | def clean(self, *args, **kwargs):
for key in list(self.store.keys()):
self.unset(key) | [
"def",
"clean",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"for",
"key",
"in",
"list",
"(",
"self",
".",
"store",
".",
"keys",
"(",
")",
")",
":",
"self",
".",
"unset",
"(",
"key",
")"
] | Clean all loaded values to reload when switching envs | [
"Clean",
"all",
"loaded",
"values",
"to",
"reload",
"when",
"switching",
"envs"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L534-L537 |
243,555 | rochacbruno/dynaconf | dynaconf/base.py | Settings.unset | def unset(self, key):
"""Unset on all references
:param key: The key to be unset
"""
key = key.strip().upper()
if key not in dir(default_settings) and key not in self._defaults:
self.logger.debug("Unset %s", key)
delattr(self, key)
self.store.... | python | def unset(self, key):
key = key.strip().upper()
if key not in dir(default_settings) and key not in self._defaults:
self.logger.debug("Unset %s", key)
delattr(self, key)
self.store.pop(key, None) | [
"def",
"unset",
"(",
"self",
",",
"key",
")",
":",
"key",
"=",
"key",
".",
"strip",
"(",
")",
".",
"upper",
"(",
")",
"if",
"key",
"not",
"in",
"dir",
"(",
"default_settings",
")",
"and",
"key",
"not",
"in",
"self",
".",
"_defaults",
":",
"self",... | Unset on all references
:param key: The key to be unset | [
"Unset",
"on",
"all",
"references"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L539-L548 |
243,556 | rochacbruno/dynaconf | dynaconf/base.py | Settings.set | def set(
self,
key,
value,
loader_identifier=None,
tomlfy=False,
dotted_lookup=True,
is_secret=False,
):
"""Set a value storing references for the loader
:param key: The key to store
:param value: The value to store
:param load... | python | def set(
self,
key,
value,
loader_identifier=None,
tomlfy=False,
dotted_lookup=True,
is_secret=False,
):
if "." in key and dotted_lookup is True:
return self._dotted_set(
key, value, loader_identifier=loader_identifier, toml... | [
"def",
"set",
"(",
"self",
",",
"key",
",",
"value",
",",
"loader_identifier",
"=",
"None",
",",
"tomlfy",
"=",
"False",
",",
"dotted_lookup",
"=",
"True",
",",
"is_secret",
"=",
"False",
",",
")",
":",
"if",
"\".\"",
"in",
"key",
"and",
"dotted_lookup... | Set a value storing references for the loader
:param key: The key to store
:param value: The value to store
:param loader_identifier: Optional loader name e.g: toml, yaml etc.
:param tomlfy: Bool define if value is parsed by toml (defaults False)
:param is_secret: Bool define if... | [
"Set",
"a",
"value",
"storing",
"references",
"for",
"the",
"loader"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L572-L616 |
243,557 | rochacbruno/dynaconf | dynaconf/base.py | Settings._merge_before_set | def _merge_before_set(self, key, existing, value, is_secret):
"""Merge the new value being set with the existing value before set"""
def _log_before_merging(_value):
self.logger.debug(
"Merging existing %s: %s with new: %s", key, existing, _value
)
def _... | python | def _merge_before_set(self, key, existing, value, is_secret):
def _log_before_merging(_value):
self.logger.debug(
"Merging existing %s: %s with new: %s", key, existing, _value
)
def _log_after_merge(_value):
self.logger.debug("%s merged to %s", key, _... | [
"def",
"_merge_before_set",
"(",
"self",
",",
"key",
",",
"existing",
",",
"value",
",",
"is_secret",
")",
":",
"def",
"_log_before_merging",
"(",
"_value",
")",
":",
"self",
".",
"logger",
".",
"debug",
"(",
"\"Merging existing %s: %s with new: %s\"",
",",
"k... | Merge the new value being set with the existing value before set | [
"Merge",
"the",
"new",
"value",
"being",
"set",
"with",
"the",
"existing",
"value",
"before",
"set"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L655-L713 |
243,558 | rochacbruno/dynaconf | dynaconf/base.py | Settings.loaders | def loaders(self): # pragma: no cover
"""Return available loaders"""
if self.LOADERS_FOR_DYNACONF in (None, 0, "0", "false", False):
self.logger.info("No loader defined")
return []
if not self._loaders:
for loader_module_name in self.LOADERS_FOR_DYNACONF:
... | python | def loaders(self): # pragma: no cover
if self.LOADERS_FOR_DYNACONF in (None, 0, "0", "false", False):
self.logger.info("No loader defined")
return []
if not self._loaders:
for loader_module_name in self.LOADERS_FOR_DYNACONF:
loader = importlib.import... | [
"def",
"loaders",
"(",
"self",
")",
":",
"# pragma: no cover",
"if",
"self",
".",
"LOADERS_FOR_DYNACONF",
"in",
"(",
"None",
",",
"0",
",",
"\"0\"",
",",
"\"false\"",
",",
"False",
")",
":",
"self",
".",
"logger",
".",
"info",
"(",
"\"No loader defined\"",... | Return available loaders | [
"Return",
"available",
"loaders"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L716-L727 |
243,559 | rochacbruno/dynaconf | dynaconf/base.py | Settings.reload | def reload(self, env=None, silent=None): # pragma: no cover
"""Clean end Execute all loaders"""
self.clean()
self.execute_loaders(env, silent) | python | def reload(self, env=None, silent=None): # pragma: no cover
self.clean()
self.execute_loaders(env, silent) | [
"def",
"reload",
"(",
"self",
",",
"env",
"=",
"None",
",",
"silent",
"=",
"None",
")",
":",
"# pragma: no cover",
"self",
".",
"clean",
"(",
")",
"self",
".",
"execute_loaders",
"(",
"env",
",",
"silent",
")"
] | Clean end Execute all loaders | [
"Clean",
"end",
"Execute",
"all",
"loaders"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L729-L732 |
243,560 | rochacbruno/dynaconf | dynaconf/base.py | Settings.execute_loaders | def execute_loaders(self, env=None, silent=None, key=None, filename=None):
"""Execute all internal and registered loaders
:param env: The environment to load
:param silent: If loading erros is silenced
:param key: if provided load a single key
:param filename: optional custom fi... | python | def execute_loaders(self, env=None, silent=None, key=None, filename=None):
if key is None:
default_loader(self, self._defaults)
env = (env or self.current_env).upper()
silent = silent or self.SILENT_ERRORS_FOR_DYNACONF
settings_loader(
self, env=env, silent=silent... | [
"def",
"execute_loaders",
"(",
"self",
",",
"env",
"=",
"None",
",",
"silent",
"=",
"None",
",",
"key",
"=",
"None",
",",
"filename",
"=",
"None",
")",
":",
"if",
"key",
"is",
"None",
":",
"default_loader",
"(",
"self",
",",
"self",
".",
"_defaults",... | Execute all internal and registered loaders
:param env: The environment to load
:param silent: If loading erros is silenced
:param key: if provided load a single key
:param filename: optional custom filename to load | [
"Execute",
"all",
"internal",
"and",
"registered",
"loaders"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L734-L755 |
243,561 | rochacbruno/dynaconf | dynaconf/base.py | Settings.load_includes | def load_includes(self, env, silent, key):
"""Do we have any nested includes we need to process?"""
includes = self.get("DYNACONF_INCLUDE", [])
includes.extend(ensure_a_list(self.get("INCLUDES_FOR_DYNACONF")))
if includes:
self.logger.debug("Processing includes %s", includes)... | python | def load_includes(self, env, silent, key):
includes = self.get("DYNACONF_INCLUDE", [])
includes.extend(ensure_a_list(self.get("INCLUDES_FOR_DYNACONF")))
if includes:
self.logger.debug("Processing includes %s", includes)
self.load_file(path=includes, env=env, silent=silent... | [
"def",
"load_includes",
"(",
"self",
",",
"env",
",",
"silent",
",",
"key",
")",
":",
"includes",
"=",
"self",
".",
"get",
"(",
"\"DYNACONF_INCLUDE\"",
",",
"[",
"]",
")",
"includes",
".",
"extend",
"(",
"ensure_a_list",
"(",
"self",
".",
"get",
"(",
... | Do we have any nested includes we need to process? | [
"Do",
"we",
"have",
"any",
"nested",
"includes",
"we",
"need",
"to",
"process?"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L757-L763 |
243,562 | rochacbruno/dynaconf | dynaconf/base.py | Settings.load_file | def load_file(self, path=None, env=None, silent=True, key=None):
"""Programmatically load files from ``path``.
:param path: A single filename or a file list
:param env: Which env to load from file (default current_env)
:param silent: Should raise errors?
:param key: Load a singl... | python | def load_file(self, path=None, env=None, silent=True, key=None):
env = (env or self.current_env).upper()
files = ensure_a_list(path)
if files:
self.logger.debug("Got %s files to process", files)
already_loaded = set()
for _filename in files:
se... | [
"def",
"load_file",
"(",
"self",
",",
"path",
"=",
"None",
",",
"env",
"=",
"None",
",",
"silent",
"=",
"True",
",",
"key",
"=",
"None",
")",
":",
"env",
"=",
"(",
"env",
"or",
"self",
".",
"current_env",
")",
".",
"upper",
"(",
")",
"files",
"... | Programmatically load files from ``path``.
:param path: A single filename or a file list
:param env: Which env to load from file (default current_env)
:param silent: Should raise errors?
:param key: Load a single key? | [
"Programmatically",
"load",
"files",
"from",
"path",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L765-L799 |
243,563 | rochacbruno/dynaconf | dynaconf/base.py | Settings._root_path | def _root_path(self):
"""ROOT_PATH_FOR_DYNACONF or the path of first loaded file or '.'"""
if self.ROOT_PATH_FOR_DYNACONF is not None:
return self.ROOT_PATH_FOR_DYNACONF
elif self._loaded_files: # called once
root_path = os.path.dirname(self._loaded_files[0])
... | python | def _root_path(self):
"""ROOT_PATH_FOR_DYNACONF or the path of first loaded file or '.'"""
if self.ROOT_PATH_FOR_DYNACONF is not None:
return self.ROOT_PATH_FOR_DYNACONF
elif self._loaded_files: # called once
root_path = os.path.dirname(self._loaded_files[0])
... | [
"def",
"_root_path",
"(",
"self",
")",
":",
"if",
"self",
".",
"ROOT_PATH_FOR_DYNACONF",
"is",
"not",
"None",
":",
"return",
"self",
".",
"ROOT_PATH_FOR_DYNACONF",
"elif",
"self",
".",
"_loaded_files",
":",
"# called once",
"root_path",
"=",
"os",
".",
"path",... | ROOT_PATH_FOR_DYNACONF or the path of first loaded file or '. | [
"ROOT_PATH_FOR_DYNACONF",
"or",
"the",
"path",
"of",
"first",
"loaded",
"file",
"or",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L802-L809 |
243,564 | rochacbruno/dynaconf | dynaconf/base.py | Settings.load_extra_yaml | def load_extra_yaml(self, env, silent, key):
"""This is deprecated, kept for compat
.. deprecated:: 1.0.0
Use multiple settings or INCLUDES_FOR_DYNACONF files instead.
"""
if self.get("YAML") is not None:
self.logger.warning(
"The use of YAML var ... | python | def load_extra_yaml(self, env, silent, key):
if self.get("YAML") is not None:
self.logger.warning(
"The use of YAML var is deprecated, please define multiple "
"filepaths instead: "
"e.g: SETTINGS_FILE_FOR_DYNACONF = "
"'settings.py,set... | [
"def",
"load_extra_yaml",
"(",
"self",
",",
"env",
",",
"silent",
",",
"key",
")",
":",
"if",
"self",
".",
"get",
"(",
"\"YAML\"",
")",
"is",
"not",
"None",
":",
"self",
".",
"logger",
".",
"warning",
"(",
"\"The use of YAML var is deprecated, please define ... | This is deprecated, kept for compat
.. deprecated:: 1.0.0
Use multiple settings or INCLUDES_FOR_DYNACONF files instead. | [
"This",
"is",
"deprecated",
"kept",
"for",
"compat"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L811-L831 |
243,565 | rochacbruno/dynaconf | dynaconf/base.py | Settings.path_for | def path_for(self, *args):
"""Path containing _root_path"""
if args and args[0].startswith(os.path.sep):
return os.path.join(*args)
return os.path.join(self._root_path or os.getcwd(), *args) | python | def path_for(self, *args):
if args and args[0].startswith(os.path.sep):
return os.path.join(*args)
return os.path.join(self._root_path or os.getcwd(), *args) | [
"def",
"path_for",
"(",
"self",
",",
"*",
"args",
")",
":",
"if",
"args",
"and",
"args",
"[",
"0",
"]",
".",
"startswith",
"(",
"os",
".",
"path",
".",
"sep",
")",
":",
"return",
"os",
".",
"path",
".",
"join",
"(",
"*",
"args",
")",
"return",
... | Path containing _root_path | [
"Path",
"containing",
"_root_path"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L833-L837 |
243,566 | rochacbruno/dynaconf | dynaconf/base.py | Settings.validators | def validators(self):
"""Gets or creates validator wrapper"""
if not hasattr(self, "_validators"):
self._validators = ValidatorList(self)
return self._validators | python | def validators(self):
if not hasattr(self, "_validators"):
self._validators = ValidatorList(self)
return self._validators | [
"def",
"validators",
"(",
"self",
")",
":",
"if",
"not",
"hasattr",
"(",
"self",
",",
"\"_validators\"",
")",
":",
"self",
".",
"_validators",
"=",
"ValidatorList",
"(",
"self",
")",
"return",
"self",
".",
"_validators"
] | Gets or creates validator wrapper | [
"Gets",
"or",
"creates",
"validator",
"wrapper"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L847-L851 |
243,567 | rochacbruno/dynaconf | dynaconf/base.py | Settings.populate_obj | def populate_obj(self, obj, keys=None):
"""Given the `obj` populate it using self.store items."""
keys = keys or self.keys()
for key in keys:
key = key.upper()
value = self.get(key, empty)
if value is not empty:
setattr(obj, key, value) | python | def populate_obj(self, obj, keys=None):
keys = keys or self.keys()
for key in keys:
key = key.upper()
value = self.get(key, empty)
if value is not empty:
setattr(obj, key, value) | [
"def",
"populate_obj",
"(",
"self",
",",
"obj",
",",
"keys",
"=",
"None",
")",
":",
"keys",
"=",
"keys",
"or",
"self",
".",
"keys",
"(",
")",
"for",
"key",
"in",
"keys",
":",
"key",
"=",
"key",
".",
"upper",
"(",
")",
"value",
"=",
"self",
".",... | Given the `obj` populate it using self.store items. | [
"Given",
"the",
"obj",
"populate",
"it",
"using",
"self",
".",
"store",
"items",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/base.py#L878-L885 |
243,568 | rochacbruno/dynaconf | dynaconf/loaders/__init__.py | default_loader | def default_loader(obj, defaults=None):
"""Loads default settings and check if there are overridings
exported as environment variables"""
defaults = defaults or {}
default_settings_values = {
key: value
for key, value in default_settings.__dict__.items() # noqa
if key.isupper()
... | python | def default_loader(obj, defaults=None):
defaults = defaults or {}
default_settings_values = {
key: value
for key, value in default_settings.__dict__.items() # noqa
if key.isupper()
}
all_keys = deduplicate(
list(defaults.keys()) + list(default_settings_values.keys())
... | [
"def",
"default_loader",
"(",
"obj",
",",
"defaults",
"=",
"None",
")",
":",
"defaults",
"=",
"defaults",
"or",
"{",
"}",
"default_settings_values",
"=",
"{",
"key",
":",
"value",
"for",
"key",
",",
"value",
"in",
"default_settings",
".",
"__dict__",
".",
... | Loads default settings and check if there are overridings
exported as environment variables | [
"Loads",
"default",
"settings",
"and",
"check",
"if",
"there",
"are",
"overridings",
"exported",
"as",
"environment",
"variables"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/loaders/__init__.py#L15-L56 |
243,569 | rochacbruno/dynaconf | dynaconf/loaders/__init__.py | settings_loader | def settings_loader(
obj, settings_module=None, env=None, silent=True, key=None, filename=None
):
"""Loads from defined settings module
:param obj: A dynaconf instance
:param settings_module: A path or a list of paths e.g settings.toml
:param env: Env to look for data defaults: development
:par... | python | def settings_loader(
obj, settings_module=None, env=None, silent=True, key=None, filename=None
):
if filename is None:
settings_module = settings_module or obj.settings_module
if not settings_module: # pragma: no cover
return
files = ensure_a_list(settings_module)
else:
... | [
"def",
"settings_loader",
"(",
"obj",
",",
"settings_module",
"=",
"None",
",",
"env",
"=",
"None",
",",
"silent",
"=",
"True",
",",
"key",
"=",
"None",
",",
"filename",
"=",
"None",
")",
":",
"if",
"filename",
"is",
"None",
":",
"settings_module",
"="... | Loads from defined settings module
:param obj: A dynaconf instance
:param settings_module: A path or a list of paths e.g settings.toml
:param env: Env to look for data defaults: development
:param silent: Boolean to raise loading errors
:param key: Load a single key if provided
:param filename:... | [
"Loads",
"from",
"defined",
"settings",
"module"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/loaders/__init__.py#L59-L159 |
243,570 | rochacbruno/dynaconf | dynaconf/loaders/__init__.py | enable_external_loaders | def enable_external_loaders(obj):
"""Enable external service loaders like `VAULT_` and `REDIS_`
looks forenv variables like `REDIS_ENABLED_FOR_DYNACONF`
"""
for name, loader in ct.EXTERNAL_LOADERS.items():
enabled = getattr(
obj, "{}_ENABLED_FOR_DYNACONF".format(name.upper()), False
... | python | def enable_external_loaders(obj):
for name, loader in ct.EXTERNAL_LOADERS.items():
enabled = getattr(
obj, "{}_ENABLED_FOR_DYNACONF".format(name.upper()), False
)
if (
enabled
and enabled not in false_values
and loader not in obj.LOADERS_FOR_DY... | [
"def",
"enable_external_loaders",
"(",
"obj",
")",
":",
"for",
"name",
",",
"loader",
"in",
"ct",
".",
"EXTERNAL_LOADERS",
".",
"items",
"(",
")",
":",
"enabled",
"=",
"getattr",
"(",
"obj",
",",
"\"{}_ENABLED_FOR_DYNACONF\"",
".",
"format",
"(",
"name",
"... | Enable external service loaders like `VAULT_` and `REDIS_`
looks forenv variables like `REDIS_ENABLED_FOR_DYNACONF` | [
"Enable",
"external",
"service",
"loaders",
"like",
"VAULT_",
"and",
"REDIS_",
"looks",
"forenv",
"variables",
"like",
"REDIS_ENABLED_FOR_DYNACONF"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/loaders/__init__.py#L162-L176 |
243,571 | rochacbruno/dynaconf | dynaconf/utils/files.py | _walk_to_root | def _walk_to_root(path, break_at=None):
"""
Directories starting from the given directory up to the root or break_at
"""
if not os.path.exists(path): # pragma: no cover
raise IOError("Starting path not found")
if os.path.isfile(path): # pragma: no cover
path = os.path.dirname(path... | python | def _walk_to_root(path, break_at=None):
if not os.path.exists(path): # pragma: no cover
raise IOError("Starting path not found")
if os.path.isfile(path): # pragma: no cover
path = os.path.dirname(path)
last_dir = None
current_dir = os.path.abspath(path)
paths = []
while last_... | [
"def",
"_walk_to_root",
"(",
"path",
",",
"break_at",
"=",
"None",
")",
":",
"if",
"not",
"os",
".",
"path",
".",
"exists",
"(",
"path",
")",
":",
"# pragma: no cover",
"raise",
"IOError",
"(",
"\"Starting path not found\"",
")",
"if",
"os",
".",
"path",
... | Directories starting from the given directory up to the root or break_at | [
"Directories",
"starting",
"from",
"the",
"given",
"directory",
"up",
"to",
"the",
"root",
"or",
"break_at"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/utils/files.py#L12-L33 |
243,572 | rochacbruno/dynaconf | dynaconf/utils/files.py | find_file | def find_file(filename=".env", project_root=None, skip_files=None, **kwargs):
"""Search in increasingly higher folders for the given file
Returns path to the file if found, or an empty string otherwise.
This function will build a `search_tree` based on:
- Project_root if specified
- Invoked script... | python | def find_file(filename=".env", project_root=None, skip_files=None, **kwargs):
search_tree = []
work_dir = os.getcwd()
skip_files = skip_files or []
if project_root is None:
logger.debug("No root_path for %s", filename)
else:
logger.debug("Got root_path %s for %s", project_root, file... | [
"def",
"find_file",
"(",
"filename",
"=",
"\".env\"",
",",
"project_root",
"=",
"None",
",",
"skip_files",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"search_tree",
"=",
"[",
"]",
"work_dir",
"=",
"os",
".",
"getcwd",
"(",
")",
"skip_files",
"=",
... | Search in increasingly higher folders for the given file
Returns path to the file if found, or an empty string otherwise.
This function will build a `search_tree` based on:
- Project_root if specified
- Invoked script location and its parents until root
- Current working directory
For each pa... | [
"Search",
"in",
"increasingly",
"higher",
"folders",
"for",
"the",
"given",
"file",
"Returns",
"path",
"to",
"the",
"file",
"if",
"found",
"or",
"an",
"empty",
"string",
"otherwise",
"."
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/utils/files.py#L39-L88 |
243,573 | rochacbruno/dynaconf | dynaconf/validator.py | Validator.validate | def validate(self, settings):
"""Raise ValidationError if invalid"""
if self.envs is None:
self.envs = [settings.current_env]
if self.when is not None:
try:
# inherit env if not defined
if self.when.envs is None:
self.... | python | def validate(self, settings):
if self.envs is None:
self.envs = [settings.current_env]
if self.when is not None:
try:
# inherit env if not defined
if self.when.envs is None:
self.when.envs = self.envs
self.when... | [
"def",
"validate",
"(",
"self",
",",
"settings",
")",
":",
"if",
"self",
".",
"envs",
"is",
"None",
":",
"self",
".",
"envs",
"=",
"[",
"settings",
".",
"current_env",
"]",
"if",
"self",
".",
"when",
"is",
"not",
"None",
":",
"try",
":",
"# inherit... | Raise ValidationError if invalid | [
"Raise",
"ValidationError",
"if",
"invalid"
] | 5a7cc8f8252251cbdf4f4112965801f9dfe2831d | https://github.com/rochacbruno/dynaconf/blob/5a7cc8f8252251cbdf4f4112965801f9dfe2831d/dynaconf/validator.py#L86-L113 |
243,574 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/serializers.py | ModelSerializer.to_representation | def to_representation(self, instance):
"""
Object instance -> Dict of primitive datatypes.
"""
ret = OrderedDict()
readable_fields = [
field for field in self.fields.values()
if not field.write_only
]
for field in readable_fields:
... | python | def to_representation(self, instance):
ret = OrderedDict()
readable_fields = [
field for field in self.fields.values()
if not field.write_only
]
for field in readable_fields:
try:
field_representation = self._get_field_representation(f... | [
"def",
"to_representation",
"(",
"self",
",",
"instance",
")",
":",
"ret",
"=",
"OrderedDict",
"(",
")",
"readable_fields",
"=",
"[",
"field",
"for",
"field",
"in",
"self",
".",
"fields",
".",
"values",
"(",
")",
"if",
"not",
"field",
".",
"write_only",
... | Object instance -> Dict of primitive datatypes. | [
"Object",
"instance",
"-",
">",
"Dict",
"of",
"primitive",
"datatypes",
"."
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/serializers.py#L175-L192 |
243,575 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/renderers.py | JSONRenderer.extract_attributes | def extract_attributes(cls, fields, resource):
"""
Builds the `attributes` object of the JSON API resource object.
"""
data = OrderedDict()
for field_name, field in six.iteritems(fields):
# ID is always provided in the root of JSON API so remove it from attributes
... | python | def extract_attributes(cls, fields, resource):
data = OrderedDict()
for field_name, field in six.iteritems(fields):
# ID is always provided in the root of JSON API so remove it from attributes
if field_name == 'id':
continue
# don't output a key for wr... | [
"def",
"extract_attributes",
"(",
"cls",
",",
"fields",
",",
"resource",
")",
":",
"data",
"=",
"OrderedDict",
"(",
")",
"for",
"field_name",
",",
"field",
"in",
"six",
".",
"iteritems",
"(",
"fields",
")",
":",
"# ID is always provided in the root of JSON API s... | Builds the `attributes` object of the JSON API resource object. | [
"Builds",
"the",
"attributes",
"object",
"of",
"the",
"JSON",
"API",
"resource",
"object",
"."
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/renderers.py#L50-L81 |
243,576 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/renderers.py | JSONRenderer.extract_relation_instance | def extract_relation_instance(cls, field_name, field, resource_instance, serializer):
"""
Determines what instance represents given relation and extracts it.
Relation instance is determined by given field_name or source configured on
field. As fallback is a serializer method called with... | python | def extract_relation_instance(cls, field_name, field, resource_instance, serializer):
relation_instance = None
try:
relation_instance = getattr(resource_instance, field_name)
except AttributeError:
try:
# For ManyRelatedFields if `related_name` is not set... | [
"def",
"extract_relation_instance",
"(",
"cls",
",",
"field_name",
",",
"field",
",",
"resource_instance",
",",
"serializer",
")",
":",
"relation_instance",
"=",
"None",
"try",
":",
"relation_instance",
"=",
"getattr",
"(",
"resource_instance",
",",
"field_name",
... | Determines what instance represents given relation and extracts it.
Relation instance is determined by given field_name or source configured on
field. As fallback is a serializer method called with name of field's source. | [
"Determines",
"what",
"instance",
"represents",
"given",
"relation",
"and",
"extracts",
"it",
"."
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/renderers.py#L299-L326 |
243,577 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/renderers.py | JSONRenderer.extract_meta | def extract_meta(cls, serializer, resource):
"""
Gathers the data from serializer fields specified in meta_fields and adds it to
the meta object.
"""
if hasattr(serializer, 'child'):
meta = getattr(serializer.child, 'Meta', None)
else:
meta = getat... | python | def extract_meta(cls, serializer, resource):
if hasattr(serializer, 'child'):
meta = getattr(serializer.child, 'Meta', None)
else:
meta = getattr(serializer, 'Meta', None)
meta_fields = getattr(meta, 'meta_fields', [])
data = OrderedDict()
for field_name i... | [
"def",
"extract_meta",
"(",
"cls",
",",
"serializer",
",",
"resource",
")",
":",
"if",
"hasattr",
"(",
"serializer",
",",
"'child'",
")",
":",
"meta",
"=",
"getattr",
"(",
"serializer",
".",
"child",
",",
"'Meta'",
",",
"None",
")",
"else",
":",
"meta"... | Gathers the data from serializer fields specified in meta_fields and adds it to
the meta object. | [
"Gathers",
"the",
"data",
"from",
"serializer",
"fields",
"specified",
"in",
"meta_fields",
"and",
"adds",
"it",
"to",
"the",
"meta",
"object",
"."
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/renderers.py#L458-L473 |
243,578 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/renderers.py | JSONRenderer.extract_root_meta | def extract_root_meta(cls, serializer, resource):
"""
Calls a `get_root_meta` function on a serializer, if it exists.
"""
many = False
if hasattr(serializer, 'child'):
many = True
serializer = serializer.child
data = {}
if getattr(serializ... | python | def extract_root_meta(cls, serializer, resource):
many = False
if hasattr(serializer, 'child'):
many = True
serializer = serializer.child
data = {}
if getattr(serializer, 'get_root_meta', None):
json_api_meta = serializer.get_root_meta(resource, many)... | [
"def",
"extract_root_meta",
"(",
"cls",
",",
"serializer",
",",
"resource",
")",
":",
"many",
"=",
"False",
"if",
"hasattr",
"(",
"serializer",
",",
"'child'",
")",
":",
"many",
"=",
"True",
"serializer",
"=",
"serializer",
".",
"child",
"data",
"=",
"{"... | Calls a `get_root_meta` function on a serializer, if it exists. | [
"Calls",
"a",
"get_root_meta",
"function",
"on",
"a",
"serializer",
"if",
"it",
"exists",
"."
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/renderers.py#L476-L490 |
243,579 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/views.py | PrefetchForIncludesHelperMixin.get_queryset | def get_queryset(self):
"""
This viewset provides a helper attribute to prefetch related models
based on the include specified in the URL.
__all__ can be used to specify a prefetch which should be done regardless of the include
.. code:: python
# When MyViewSet is ... | python | def get_queryset(self):
qs = super(PrefetchForIncludesHelperMixin, self).get_queryset()
if not hasattr(self, 'prefetch_for_includes'):
return qs
includes = self.request.GET.get('include', '').split(',')
for inc in includes + ['__all__']:
prefetches = self.prefetc... | [
"def",
"get_queryset",
"(",
"self",
")",
":",
"qs",
"=",
"super",
"(",
"PrefetchForIncludesHelperMixin",
",",
"self",
")",
".",
"get_queryset",
"(",
")",
"if",
"not",
"hasattr",
"(",
"self",
",",
"'prefetch_for_includes'",
")",
":",
"return",
"qs",
"includes... | This viewset provides a helper attribute to prefetch related models
based on the include specified in the URL.
__all__ can be used to specify a prefetch which should be done regardless of the include
.. code:: python
# When MyViewSet is called with ?include=author it will prefetch... | [
"This",
"viewset",
"provides",
"a",
"helper",
"attribute",
"to",
"prefetch",
"related",
"models",
"based",
"on",
"the",
"include",
"specified",
"in",
"the",
"URL",
"."
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/views.py#L34-L62 |
243,580 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/views.py | AutoPrefetchMixin.get_queryset | def get_queryset(self, *args, **kwargs):
""" This mixin adds automatic prefetching for OneToOne and ManyToMany fields. """
qs = super(AutoPrefetchMixin, self).get_queryset(*args, **kwargs)
included_resources = get_included_resources(self.request)
for included in included_resources:
... | python | def get_queryset(self, *args, **kwargs):
qs = super(AutoPrefetchMixin, self).get_queryset(*args, **kwargs)
included_resources = get_included_resources(self.request)
for included in included_resources:
included_model = None
levels = included.split('.')
level_m... | [
"def",
"get_queryset",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"qs",
"=",
"super",
"(",
"AutoPrefetchMixin",
",",
"self",
")",
".",
"get_queryset",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"included_resources",
"=",
"... | This mixin adds automatic prefetching for OneToOne and ManyToMany fields. | [
"This",
"mixin",
"adds",
"automatic",
"prefetching",
"for",
"OneToOne",
"and",
"ManyToMany",
"fields",
"."
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/views.py#L66-L109 |
243,581 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/views.py | RelationshipView.get_url | def get_url(self, name, view_name, kwargs, request):
"""
Given a name, view name and kwargs, return the URL that hyperlinks to the object.
May raise a `NoReverseMatch` if the `view_name` and `lookup_field`
attributes are not configured to correctly match the URL conf.
"""
... | python | def get_url(self, name, view_name, kwargs, request):
# Return None if the view name is not supplied
if not view_name:
return None
# Return the hyperlink, or error if incorrectly configured.
try:
url = self.reverse(view_name, kwargs=kwargs, request=request)
... | [
"def",
"get_url",
"(",
"self",
",",
"name",
",",
"view_name",
",",
"kwargs",
",",
"request",
")",
":",
"# Return None if the view name is not supplied",
"if",
"not",
"view_name",
":",
"return",
"None",
"# Return the hyperlink, or error if incorrectly configured.",
"try",
... | Given a name, view name and kwargs, return the URL that hyperlinks to the object.
May raise a `NoReverseMatch` if the `view_name` and `lookup_field`
attributes are not configured to correctly match the URL conf. | [
"Given",
"a",
"name",
"view",
"name",
"and",
"kwargs",
"return",
"the",
"URL",
"that",
"hyperlinks",
"to",
"the",
"object",
"."
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/views.py#L221-L248 |
243,582 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/utils.py | get_resource_name | def get_resource_name(context, expand_polymorphic_types=False):
"""
Return the name of a resource.
"""
from rest_framework_json_api.serializers import PolymorphicModelSerializer
view = context.get('view')
# Sanity check to make sure we have a view.
if not view:
return None
# Ch... | python | def get_resource_name(context, expand_polymorphic_types=False):
from rest_framework_json_api.serializers import PolymorphicModelSerializer
view = context.get('view')
# Sanity check to make sure we have a view.
if not view:
return None
# Check to see if there is a status code and return ear... | [
"def",
"get_resource_name",
"(",
"context",
",",
"expand_polymorphic_types",
"=",
"False",
")",
":",
"from",
"rest_framework_json_api",
".",
"serializers",
"import",
"PolymorphicModelSerializer",
"view",
"=",
"context",
".",
"get",
"(",
"'view'",
")",
"# Sanity check ... | Return the name of a resource. | [
"Return",
"the",
"name",
"of",
"a",
"resource",
"."
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/utils.py#L36-L79 |
243,583 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/utils.py | format_field_names | def format_field_names(obj, format_type=None):
"""
Takes a dict and returns it with formatted keys as set in `format_type`
or `JSON_API_FORMAT_FIELD_NAMES`
:format_type: Either 'dasherize', 'camelize', 'capitalize' or 'underscore'
"""
if format_type is None:
format_type = json_api_setti... | python | def format_field_names(obj, format_type=None):
if format_type is None:
format_type = json_api_settings.FORMAT_FIELD_NAMES
if isinstance(obj, dict):
formatted = OrderedDict()
for key, value in obj.items():
key = format_value(key, format_type)
formatted[key] = valu... | [
"def",
"format_field_names",
"(",
"obj",
",",
"format_type",
"=",
"None",
")",
":",
"if",
"format_type",
"is",
"None",
":",
"format_type",
"=",
"json_api_settings",
".",
"FORMAT_FIELD_NAMES",
"if",
"isinstance",
"(",
"obj",
",",
"dict",
")",
":",
"formatted",
... | Takes a dict and returns it with formatted keys as set in `format_type`
or `JSON_API_FORMAT_FIELD_NAMES`
:format_type: Either 'dasherize', 'camelize', 'capitalize' or 'underscore' | [
"Takes",
"a",
"dict",
"and",
"returns",
"it",
"with",
"formatted",
"keys",
"as",
"set",
"in",
"format_type",
"or",
"JSON_API_FORMAT_FIELD_NAMES"
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/utils.py#L101-L118 |
243,584 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/utils.py | _format_object | def _format_object(obj, format_type=None):
"""Depending on settings calls either `format_keys` or `format_field_names`"""
if json_api_settings.FORMAT_KEYS is not None:
return format_keys(obj, format_type)
return format_field_names(obj, format_type) | python | def _format_object(obj, format_type=None):
if json_api_settings.FORMAT_KEYS is not None:
return format_keys(obj, format_type)
return format_field_names(obj, format_type) | [
"def",
"_format_object",
"(",
"obj",
",",
"format_type",
"=",
"None",
")",
":",
"if",
"json_api_settings",
".",
"FORMAT_KEYS",
"is",
"not",
"None",
":",
"return",
"format_keys",
"(",
"obj",
",",
"format_type",
")",
"return",
"format_field_names",
"(",
"obj",
... | Depending on settings calls either `format_keys` or `format_field_names` | [
"Depending",
"on",
"settings",
"calls",
"either",
"format_keys",
"or",
"format_field_names"
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/utils.py#L121-L127 |
243,585 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/utils.py | get_included_resources | def get_included_resources(request, serializer=None):
""" Build a list of included resources. """
include_resources_param = request.query_params.get('include') if request else None
if include_resources_param:
return include_resources_param.split(',')
else:
return get_default_included_res... | python | def get_included_resources(request, serializer=None):
include_resources_param = request.query_params.get('include') if request else None
if include_resources_param:
return include_resources_param.split(',')
else:
return get_default_included_resources_from_serializer(serializer) | [
"def",
"get_included_resources",
"(",
"request",
",",
"serializer",
"=",
"None",
")",
":",
"include_resources_param",
"=",
"request",
".",
"query_params",
".",
"get",
"(",
"'include'",
")",
"if",
"request",
"else",
"None",
"if",
"include_resources_param",
":",
"... | Build a list of included resources. | [
"Build",
"a",
"list",
"of",
"included",
"resources",
"."
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/utils.py#L327-L333 |
243,586 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/parsers.py | JSONParser.parse | def parse(self, stream, media_type=None, parser_context=None):
"""
Parses the incoming bytestream as JSON and returns the resulting data
"""
result = super(JSONParser, self).parse(
stream, media_type=media_type, parser_context=parser_context
)
if not isinstan... | python | def parse(self, stream, media_type=None, parser_context=None):
result = super(JSONParser, self).parse(
stream, media_type=media_type, parser_context=parser_context
)
if not isinstance(result, dict) or 'data' not in result:
raise ParseError('Received document does not con... | [
"def",
"parse",
"(",
"self",
",",
"stream",
",",
"media_type",
"=",
"None",
",",
"parser_context",
"=",
"None",
")",
":",
"result",
"=",
"super",
"(",
"JSONParser",
",",
"self",
")",
".",
"parse",
"(",
"stream",
",",
"media_type",
"=",
"media_type",
",... | Parses the incoming bytestream as JSON and returns the resulting data | [
"Parses",
"the",
"incoming",
"bytestream",
"as",
"JSON",
"and",
"returns",
"the",
"resulting",
"data"
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/parsers.py#L85-L153 |
243,587 | django-json-api/django-rest-framework-json-api | rest_framework_json_api/relations.py | ResourceRelatedField.get_resource_type_from_included_serializer | def get_resource_type_from_included_serializer(self):
"""
Check to see it this resource has a different resource_name when
included and return that name, or None
"""
field_name = self.field_name or self.parent.field_name
parent = self.get_parent_serializer()
if p... | python | def get_resource_type_from_included_serializer(self):
field_name = self.field_name or self.parent.field_name
parent = self.get_parent_serializer()
if parent is not None:
# accept both singular and plural versions of field_name
field_names = [
inflection.s... | [
"def",
"get_resource_type_from_included_serializer",
"(",
"self",
")",
":",
"field_name",
"=",
"self",
".",
"field_name",
"or",
"self",
".",
"parent",
".",
"field_name",
"parent",
"=",
"self",
".",
"get_parent_serializer",
"(",
")",
"if",
"parent",
"is",
"not",
... | Check to see it this resource has a different resource_name when
included and return that name, or None | [
"Check",
"to",
"see",
"it",
"this",
"resource",
"has",
"a",
"different",
"resource_name",
"when",
"included",
"and",
"return",
"that",
"name",
"or",
"None"
] | de7021f9e011615ce8b65d0cb38227c6c12721b6 | https://github.com/django-json-api/django-rest-framework-json-api/blob/de7021f9e011615ce8b65d0cb38227c6c12721b6/rest_framework_json_api/relations.py#L255-L274 |
243,588 | oauthlib/oauthlib | oauthlib/oauth1/rfc5849/signature.py | sign_plaintext | def sign_plaintext(client_secret, resource_owner_secret):
"""Sign a request using plaintext.
Per `section 3.4.4`_ of the spec.
The "PLAINTEXT" method does not employ a signature algorithm. It
MUST be used with a transport-layer mechanism such as TLS or SSL (or
sent over a secure channel with equi... | python | def sign_plaintext(client_secret, resource_owner_secret):
# The "oauth_signature" protocol parameter is set to the concatenated
# value of:
# 1. The client shared-secret, after being encoded (`Section 3.6`_).
#
# .. _`Section 3.6`: https://tools.ietf.org/html/rfc5849#section-3.6
signature = ut... | [
"def",
"sign_plaintext",
"(",
"client_secret",
",",
"resource_owner_secret",
")",
":",
"# The \"oauth_signature\" protocol parameter is set to the concatenated",
"# value of:",
"# 1. The client shared-secret, after being encoded (`Section 3.6`_).",
"#",
"# .. _`Section 3.6`: https://tools.i... | Sign a request using plaintext.
Per `section 3.4.4`_ of the spec.
The "PLAINTEXT" method does not employ a signature algorithm. It
MUST be used with a transport-layer mechanism such as TLS or SSL (or
sent over a secure channel with equivalent protections). It does not
utilize the signature base ... | [
"Sign",
"a",
"request",
"using",
"plaintext",
"."
] | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth1/rfc5849/signature.py#L595-L627 |
243,589 | oauthlib/oauthlib | oauthlib/oauth1/rfc5849/signature.py | verify_hmac_sha1 | def verify_hmac_sha1(request, client_secret=None,
resource_owner_secret=None):
"""Verify a HMAC-SHA1 signature.
Per `section 3.4`_ of the spec.
.. _`section 3.4`: https://tools.ietf.org/html/rfc5849#section-3.4
To satisfy `RFC2616 section 5.2`_ item 1, the request argument's uri
... | python | def verify_hmac_sha1(request, client_secret=None,
resource_owner_secret=None):
norm_params = normalize_parameters(request.params)
bs_uri = base_string_uri(request.uri)
sig_base_str = signature_base_string(request.http_method, bs_uri,
norm_params)... | [
"def",
"verify_hmac_sha1",
"(",
"request",
",",
"client_secret",
"=",
"None",
",",
"resource_owner_secret",
"=",
"None",
")",
":",
"norm_params",
"=",
"normalize_parameters",
"(",
"request",
".",
"params",
")",
"bs_uri",
"=",
"base_string_uri",
"(",
"request",
"... | Verify a HMAC-SHA1 signature.
Per `section 3.4`_ of the spec.
.. _`section 3.4`: https://tools.ietf.org/html/rfc5849#section-3.4
To satisfy `RFC2616 section 5.2`_ item 1, the request argument's uri
attribute MUST be an absolute URI whose netloc part identifies the
origin server or gateway on whic... | [
"Verify",
"a",
"HMAC",
"-",
"SHA1",
"signature",
"."
] | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth1/rfc5849/signature.py#L634-L661 |
243,590 | oauthlib/oauthlib | oauthlib/oauth1/rfc5849/signature.py | verify_plaintext | def verify_plaintext(request, client_secret=None, resource_owner_secret=None):
"""Verify a PLAINTEXT signature.
Per `section 3.4`_ of the spec.
.. _`section 3.4`: https://tools.ietf.org/html/rfc5849#section-3.4
"""
signature = sign_plaintext(client_secret, resource_owner_secret)
match = safe_s... | python | def verify_plaintext(request, client_secret=None, resource_owner_secret=None):
signature = sign_plaintext(client_secret, resource_owner_secret)
match = safe_string_equals(signature, request.signature)
if not match:
log.debug('Verify PLAINTEXT failed')
return match | [
"def",
"verify_plaintext",
"(",
"request",
",",
"client_secret",
"=",
"None",
",",
"resource_owner_secret",
"=",
"None",
")",
":",
"signature",
"=",
"sign_plaintext",
"(",
"client_secret",
",",
"resource_owner_secret",
")",
"match",
"=",
"safe_string_equals",
"(",
... | Verify a PLAINTEXT signature.
Per `section 3.4`_ of the spec.
.. _`section 3.4`: https://tools.ietf.org/html/rfc5849#section-3.4 | [
"Verify",
"a",
"PLAINTEXT",
"signature",
"."
] | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth1/rfc5849/signature.py#L702-L713 |
243,591 | oauthlib/oauthlib | oauthlib/oauth1/rfc5849/endpoints/authorization.py | AuthorizationEndpoint.create_authorization_response | def create_authorization_response(self, uri, http_method='GET', body=None,
headers=None, realms=None, credentials=None):
"""Create an authorization response, with a new request token if valid.
:param uri: The full URI of the token request.
:param http_metho... | python | def create_authorization_response(self, uri, http_method='GET', body=None,
headers=None, realms=None, credentials=None):
request = self._create_request(uri, http_method=http_method, body=body,
headers=headers)
if not request.r... | [
"def",
"create_authorization_response",
"(",
"self",
",",
"uri",
",",
"http_method",
"=",
"'GET'",
",",
"body",
"=",
"None",
",",
"headers",
"=",
"None",
",",
"realms",
"=",
"None",
",",
"credentials",
"=",
"None",
")",
":",
"request",
"=",
"self",
".",
... | Create an authorization response, with a new request token if valid.
:param uri: The full URI of the token request.
:param http_method: A valid HTTP verb, i.e. GET, POST, PUT, HEAD, etc.
:param body: The request body as a string.
:param headers: The request headers as a dict.
:p... | [
"Create",
"an",
"authorization",
"response",
"with",
"a",
"new",
"request",
"token",
"if",
"valid",
"."
] | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth1/rfc5849/endpoints/authorization.py#L59-L139 |
243,592 | oauthlib/oauthlib | oauthlib/oauth1/rfc5849/endpoints/authorization.py | AuthorizationEndpoint.get_realms_and_credentials | def get_realms_and_credentials(self, uri, http_method='GET', body=None,
headers=None):
"""Fetch realms and credentials for the presented request token.
:param uri: The full URI of the token request.
:param http_method: A valid HTTP verb, i.e. GET, POST, PUT, H... | python | def get_realms_and_credentials(self, uri, http_method='GET', body=None,
headers=None):
request = self._create_request(uri, http_method=http_method, body=body,
headers=headers)
if not self.request_validator.verify_request_token(
... | [
"def",
"get_realms_and_credentials",
"(",
"self",
",",
"uri",
",",
"http_method",
"=",
"'GET'",
",",
"body",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"request",
"=",
"self",
".",
"_create_request",
"(",
"uri",
",",
"http_method",
"=",
"http_meth... | Fetch realms and credentials for the presented request token.
:param uri: The full URI of the token request.
:param http_method: A valid HTTP verb, i.e. GET, POST, PUT, HEAD, etc.
:param body: The request body as a string.
:param headers: The request headers as a dict.
:returns:... | [
"Fetch",
"realms",
"and",
"credentials",
"for",
"the",
"presented",
"request",
"token",
"."
] | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth1/rfc5849/endpoints/authorization.py#L141-L163 |
243,593 | oauthlib/oauthlib | oauthlib/oauth2/rfc6749/endpoints/introspect.py | IntrospectEndpoint.create_introspect_response | def create_introspect_response(self, uri, http_method='POST', body=None,
headers=None):
"""Create introspect valid or invalid response
If the authorization server is unable to determine the state
of the token without additional information, it SHOULD return
... | python | def create_introspect_response(self, uri, http_method='POST', body=None,
headers=None):
resp_headers = {
'Content-Type': 'application/json',
'Cache-Control': 'no-store',
'Pragma': 'no-cache',
}
request = Request(uri, http_met... | [
"def",
"create_introspect_response",
"(",
"self",
",",
"uri",
",",
"http_method",
"=",
"'POST'",
",",
"body",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"resp_headers",
"=",
"{",
"'Content-Type'",
":",
"'application/json'",
",",
"'Cache-Control'",
":"... | Create introspect valid or invalid response
If the authorization server is unable to determine the state
of the token without additional information, it SHOULD return
an introspection response indicating the token is not active
as described in Section 2.2. | [
"Create",
"introspect",
"valid",
"or",
"invalid",
"response"
] | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth2/rfc6749/endpoints/introspect.py#L50-L82 |
243,594 | oauthlib/oauthlib | oauthlib/oauth2/rfc6749/clients/service_application.py | ServiceApplicationClient.prepare_request_body | def prepare_request_body(self,
private_key=None,
subject=None,
issuer=None,
audience=None,
expires_at=None,
issued_at=None,
... | python | def prepare_request_body(self,
private_key=None,
subject=None,
issuer=None,
audience=None,
expires_at=None,
issued_at=None,
... | [
"def",
"prepare_request_body",
"(",
"self",
",",
"private_key",
"=",
"None",
",",
"subject",
"=",
"None",
",",
"issuer",
"=",
"None",
",",
"audience",
"=",
"None",
",",
"expires_at",
"=",
"None",
",",
"issued_at",
"=",
"None",
",",
"extra_claims",
"=",
"... | Create and add a JWT assertion to the request body.
:param private_key: Private key used for signing and encrypting.
Must be given as a string.
:param subject: (sub) The principal that is the subject of the JWT,
i.e. which user is the token requeste... | [
"Create",
"and",
"add",
"a",
"JWT",
"assertion",
"to",
"the",
"request",
"body",
"."
] | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth2/rfc6749/clients/service_application.py#L66-L190 |
243,595 | oauthlib/oauthlib | oauthlib/oauth2/rfc6749/grant_types/authorization_code.py | AuthorizationCodeGrant.create_authorization_code | def create_authorization_code(self, request):
"""
Generates an authorization grant represented as a dictionary.
:param request: OAuthlib request.
:type request: oauthlib.common.Request
"""
grant = {'code': common.generate_token()}
if hasattr(request, 'state') and... | python | def create_authorization_code(self, request):
grant = {'code': common.generate_token()}
if hasattr(request, 'state') and request.state:
grant['state'] = request.state
log.debug('Created authorization code grant %r for request %r.',
grant, request)
return gra... | [
"def",
"create_authorization_code",
"(",
"self",
",",
"request",
")",
":",
"grant",
"=",
"{",
"'code'",
":",
"common",
".",
"generate_token",
"(",
")",
"}",
"if",
"hasattr",
"(",
"request",
",",
"'state'",
")",
"and",
"request",
".",
"state",
":",
"grant... | Generates an authorization grant represented as a dictionary.
:param request: OAuthlib request.
:type request: oauthlib.common.Request | [
"Generates",
"an",
"authorization",
"grant",
"represented",
"as",
"a",
"dictionary",
"."
] | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth2/rfc6749/grant_types/authorization_code.py#L163-L175 |
243,596 | oauthlib/oauthlib | oauthlib/oauth2/rfc6749/grant_types/authorization_code.py | AuthorizationCodeGrant.create_token_response | def create_token_response(self, request, token_handler):
"""Validate the authorization code.
The client MUST NOT use the authorization code more than once. If an
authorization code is used more than once, the authorization server
MUST deny the request and SHOULD revoke (when possible) a... | python | def create_token_response(self, request, token_handler):
headers = self._get_default_headers()
try:
self.validate_token_request(request)
log.debug('Token request validation ok for %r.', request)
except errors.OAuth2Error as e:
log.debug('Client error during va... | [
"def",
"create_token_response",
"(",
"self",
",",
"request",
",",
"token_handler",
")",
":",
"headers",
"=",
"self",
".",
"_get_default_headers",
"(",
")",
"try",
":",
"self",
".",
"validate_token_request",
"(",
"request",
")",
"log",
".",
"debug",
"(",
"'To... | Validate the authorization code.
The client MUST NOT use the authorization code more than once. If an
authorization code is used more than once, the authorization server
MUST deny the request and SHOULD revoke (when possible) all tokens
previously issued based on that authorization code... | [
"Validate",
"the",
"authorization",
"code",
"."
] | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth2/rfc6749/grant_types/authorization_code.py#L284-L316 |
243,597 | oauthlib/oauthlib | oauthlib/oauth2/rfc6749/grant_types/authorization_code.py | AuthorizationCodeGrant.validate_authorization_request | def validate_authorization_request(self, request):
"""Check the authorization request for normal and fatal errors.
A normal error could be a missing response_type parameter or the client
attempting to access scope it is not allowed to ask authorization for.
Normal errors can safely be i... | python | def validate_authorization_request(self, request):
# First check for fatal errors
# If the request fails due to a missing, invalid, or mismatching
# redirection URI, or if the client identifier is missing or invalid,
# the authorization server SHOULD inform the resource owner of the
... | [
"def",
"validate_authorization_request",
"(",
"self",
",",
"request",
")",
":",
"# First check for fatal errors",
"# If the request fails due to a missing, invalid, or mismatching",
"# redirection URI, or if the client identifier is missing or invalid,",
"# the authorization server SHOULD info... | Check the authorization request for normal and fatal errors.
A normal error could be a missing response_type parameter or the client
attempting to access scope it is not allowed to ask authorization for.
Normal errors can safely be included in the redirection URI and
sent back to the cl... | [
"Check",
"the",
"authorization",
"request",
"for",
"normal",
"and",
"fatal",
"errors",
"."
] | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth2/rfc6749/grant_types/authorization_code.py#L318-L430 |
243,598 | oauthlib/oauthlib | oauthlib/oauth2/rfc6749/endpoints/metadata.py | MetadataEndpoint.create_metadata_response | def create_metadata_response(self, uri, http_method='GET', body=None,
headers=None):
"""Create metadata response
"""
headers = {
'Content-Type': 'application/json'
}
return headers, json.dumps(self.claims), 200 | python | def create_metadata_response(self, uri, http_method='GET', body=None,
headers=None):
headers = {
'Content-Type': 'application/json'
}
return headers, json.dumps(self.claims), 200 | [
"def",
"create_metadata_response",
"(",
"self",
",",
"uri",
",",
"http_method",
"=",
"'GET'",
",",
"body",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"headers",
"=",
"{",
"'Content-Type'",
":",
"'application/json'",
"}",
"return",
"headers",
",",
... | Create metadata response | [
"Create",
"metadata",
"response"
] | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth2/rfc6749/endpoints/metadata.py#L57-L64 |
243,599 | oauthlib/oauthlib | oauthlib/oauth2/rfc6749/endpoints/metadata.py | MetadataEndpoint.validate_metadata_token | def validate_metadata_token(self, claims, endpoint):
"""
If the token endpoint is used in the grant type, the value of this
parameter MUST be the same as the value of the "grant_type"
parameter passed to the token endpoint defined in the grant type
definition.
"""
... | python | def validate_metadata_token(self, claims, endpoint):
self._grant_types.extend(endpoint._grant_types.keys())
claims.setdefault("token_endpoint_auth_methods_supported", ["client_secret_post", "client_secret_basic"])
self.validate_metadata(claims, "token_endpoint_auth_methods_supported", is_list=T... | [
"def",
"validate_metadata_token",
"(",
"self",
",",
"claims",
",",
"endpoint",
")",
":",
"self",
".",
"_grant_types",
".",
"extend",
"(",
"endpoint",
".",
"_grant_types",
".",
"keys",
"(",
")",
")",
"claims",
".",
"setdefault",
"(",
"\"token_endpoint_auth_meth... | If the token endpoint is used in the grant type, the value of this
parameter MUST be the same as the value of the "grant_type"
parameter passed to the token endpoint defined in the grant type
definition. | [
"If",
"the",
"token",
"endpoint",
"is",
"used",
"in",
"the",
"grant",
"type",
"the",
"value",
"of",
"this",
"parameter",
"MUST",
"be",
"the",
"same",
"as",
"the",
"value",
"of",
"the",
"grant_type",
"parameter",
"passed",
"to",
"the",
"token",
"endpoint",
... | 30321dd3c0ca784d3508a1970cf90d9f76835c79 | https://github.com/oauthlib/oauthlib/blob/30321dd3c0ca784d3508a1970cf90d9f76835c79/oauthlib/oauth2/rfc6749/endpoints/metadata.py#L91-L103 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.