partition stringclasses 3
values | func_name stringlengths 1 134 | docstring stringlengths 1 46.9k | path stringlengths 4 223 | original_string stringlengths 75 104k | code stringlengths 75 104k | docstring_tokens listlengths 1 1.97k | repo stringlengths 7 55 | language stringclasses 1
value | url stringlengths 87 315 | code_tokens listlengths 19 28.4k | sha stringlengths 40 40 |
|---|---|---|---|---|---|---|---|---|---|---|---|
test | remove_nodes | Create DataFrames of nodes and edges that do not include specified nodes.
Parameters
----------
network : pandana.Network
rm_nodes : array_like
A list, array, Index, or Series of node IDs that should *not*
be saved as part of the Network.
Returns
-------
nodes, edges : pand... | pandana/loaders/pandash5.py | def remove_nodes(network, rm_nodes):
"""
Create DataFrames of nodes and edges that do not include specified nodes.
Parameters
----------
network : pandana.Network
rm_nodes : array_like
A list, array, Index, or Series of node IDs that should *not*
be saved as part of the Network.... | def remove_nodes(network, rm_nodes):
"""
Create DataFrames of nodes and edges that do not include specified nodes.
Parameters
----------
network : pandana.Network
rm_nodes : array_like
A list, array, Index, or Series of node IDs that should *not*
be saved as part of the Network.... | [
"Create",
"DataFrames",
"of",
"nodes",
"and",
"edges",
"that",
"do",
"not",
"include",
"specified",
"nodes",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/loaders/pandash5.py#L4-L27 | [
"def",
"remove_nodes",
"(",
"network",
",",
"rm_nodes",
")",
":",
"rm_nodes",
"=",
"set",
"(",
"rm_nodes",
")",
"ndf",
"=",
"network",
".",
"nodes_df",
"edf",
"=",
"network",
".",
"edges_df",
"nodes_to_keep",
"=",
"~",
"ndf",
".",
"index",
".",
"isin",
... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | network_to_pandas_hdf5 | Save a Network's data to a Pandas HDFStore.
Parameters
----------
network : pandana.Network
filename : str
rm_nodes : array_like
A list, array, Index, or Series of node IDs that should *not*
be saved as part of the Network. | pandana/loaders/pandash5.py | def network_to_pandas_hdf5(network, filename, rm_nodes=None):
"""
Save a Network's data to a Pandas HDFStore.
Parameters
----------
network : pandana.Network
filename : str
rm_nodes : array_like
A list, array, Index, or Series of node IDs that should *not*
be saved as part o... | def network_to_pandas_hdf5(network, filename, rm_nodes=None):
"""
Save a Network's data to a Pandas HDFStore.
Parameters
----------
network : pandana.Network
filename : str
rm_nodes : array_like
A list, array, Index, or Series of node IDs that should *not*
be saved as part o... | [
"Save",
"a",
"Network",
"s",
"data",
"to",
"a",
"Pandas",
"HDFStore",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/loaders/pandash5.py#L30-L53 | [
"def",
"network_to_pandas_hdf5",
"(",
"network",
",",
"filename",
",",
"rm_nodes",
"=",
"None",
")",
":",
"if",
"rm_nodes",
"is",
"not",
"None",
":",
"nodes",
",",
"edges",
"=",
"remove_nodes",
"(",
"network",
",",
"rm_nodes",
")",
"else",
":",
"nodes",
... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | network_from_pandas_hdf5 | Build a Network from data in a Pandas HDFStore.
Parameters
----------
cls : class
Class to instantiate, usually pandana.Network.
filename : str
Returns
-------
network : pandana.Network | pandana/loaders/pandash5.py | def network_from_pandas_hdf5(cls, filename):
"""
Build a Network from data in a Pandas HDFStore.
Parameters
----------
cls : class
Class to instantiate, usually pandana.Network.
filename : str
Returns
-------
network : pandana.Network
"""
with pd.HDFStore(filename)... | def network_from_pandas_hdf5(cls, filename):
"""
Build a Network from data in a Pandas HDFStore.
Parameters
----------
cls : class
Class to instantiate, usually pandana.Network.
filename : str
Returns
-------
network : pandana.Network
"""
with pd.HDFStore(filename)... | [
"Build",
"a",
"Network",
"from",
"data",
"in",
"a",
"Pandas",
"HDFStore",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/loaders/pandash5.py#L56-L79 | [
"def",
"network_from_pandas_hdf5",
"(",
"cls",
",",
"filename",
")",
":",
"with",
"pd",
".",
"HDFStore",
"(",
"filename",
")",
"as",
"store",
":",
"nodes",
"=",
"store",
"[",
"'nodes'",
"]",
"edges",
"=",
"store",
"[",
"'edges'",
"]",
"two_way",
"=",
"... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | Network.bbox | The bounding box for nodes in this network [xmin, ymin, xmax, ymax] | pandana/network.py | def bbox(self):
"""
The bounding box for nodes in this network [xmin, ymin, xmax, ymax]
"""
return [self.nodes_df.x.min(), self.nodes_df.y.min(),
self.nodes_df.x.max(), self.nodes_df.y.max()] | def bbox(self):
"""
The bounding box for nodes in this network [xmin, ymin, xmax, ymax]
"""
return [self.nodes_df.x.min(), self.nodes_df.y.min(),
self.nodes_df.x.max(), self.nodes_df.y.max()] | [
"The",
"bounding",
"box",
"for",
"nodes",
"in",
"this",
"network",
"[",
"xmin",
"ymin",
"xmax",
"ymax",
"]"
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/network.py#L151-L156 | [
"def",
"bbox",
"(",
"self",
")",
":",
"return",
"[",
"self",
".",
"nodes_df",
".",
"x",
".",
"min",
"(",
")",
",",
"self",
".",
"nodes_df",
".",
"y",
".",
"min",
"(",
")",
",",
"self",
".",
"nodes_df",
".",
"x",
".",
"max",
"(",
")",
",",
"... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | Network.set | Characterize urban space with a variable that is related to nodes in
the network.
Parameters
----------
node_ids : Pandas Series, int
A series of node_ids which are usually computed using
get_node_ids on this object.
variable : Pandas Series, numeric, opt... | pandana/network.py | def set(self, node_ids, variable=None, name="tmp"):
"""
Characterize urban space with a variable that is related to nodes in
the network.
Parameters
----------
node_ids : Pandas Series, int
A series of node_ids which are usually computed using
get... | def set(self, node_ids, variable=None, name="tmp"):
"""
Characterize urban space with a variable that is related to nodes in
the network.
Parameters
----------
node_ids : Pandas Series, int
A series of node_ids which are usually computed using
get... | [
"Characterize",
"urban",
"space",
"with",
"a",
"variable",
"that",
"is",
"related",
"to",
"nodes",
"in",
"the",
"network",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/network.py#L188-L242 | [
"def",
"set",
"(",
"self",
",",
"node_ids",
",",
"variable",
"=",
"None",
",",
"name",
"=",
"\"tmp\"",
")",
":",
"if",
"variable",
"is",
"None",
":",
"variable",
"=",
"pd",
".",
"Series",
"(",
"np",
".",
"ones",
"(",
"len",
"(",
"node_ids",
")",
... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | Network.aggregate | Aggregate information for every source node in the network - this is
really the main purpose of this library. This allows you to touch
the data specified by calling set and perform some aggregation on it
within the specified distance. For instance, summing the population
within 1000 me... | pandana/network.py | def aggregate(self, distance, type="sum", decay="linear", imp_name=None,
name="tmp"):
"""
Aggregate information for every source node in the network - this is
really the main purpose of this library. This allows you to touch
the data specified by calling set and perfor... | def aggregate(self, distance, type="sum", decay="linear", imp_name=None,
name="tmp"):
"""
Aggregate information for every source node in the network - this is
really the main purpose of this library. This allows you to touch
the data specified by calling set and perfor... | [
"Aggregate",
"information",
"for",
"every",
"source",
"node",
"in",
"the",
"network",
"-",
"this",
"is",
"really",
"the",
"main",
"purpose",
"of",
"this",
"library",
".",
"This",
"allows",
"you",
"to",
"touch",
"the",
"data",
"specified",
"by",
"calling",
... | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/network.py#L274-L336 | [
"def",
"aggregate",
"(",
"self",
",",
"distance",
",",
"type",
"=",
"\"sum\"",
",",
"decay",
"=",
"\"linear\"",
",",
"imp_name",
"=",
"None",
",",
"name",
"=",
"\"tmp\"",
")",
":",
"imp_num",
"=",
"self",
".",
"_imp_name_to_num",
"(",
"imp_name",
")",
... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | Network.get_node_ids | Assign node_ids to data specified by x_col and y_col
Parameters
----------
x_col : Pandas series (float)
A Pandas Series where values specify the x (e.g. longitude)
location of dataset.
y_col : Pandas series (float)
A Pandas Series where values specif... | pandana/network.py | def get_node_ids(self, x_col, y_col, mapping_distance=None):
"""
Assign node_ids to data specified by x_col and y_col
Parameters
----------
x_col : Pandas series (float)
A Pandas Series where values specify the x (e.g. longitude)
location of dataset.
... | def get_node_ids(self, x_col, y_col, mapping_distance=None):
"""
Assign node_ids to data specified by x_col and y_col
Parameters
----------
x_col : Pandas series (float)
A Pandas Series where values specify the x (e.g. longitude)
location of dataset.
... | [
"Assign",
"node_ids",
"to",
"data",
"specified",
"by",
"x_col",
"and",
"y_col"
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/network.py#L338-L383 | [
"def",
"get_node_ids",
"(",
"self",
",",
"x_col",
",",
"y_col",
",",
"mapping_distance",
"=",
"None",
")",
":",
"xys",
"=",
"pd",
".",
"DataFrame",
"(",
"{",
"'x'",
":",
"x_col",
",",
"'y'",
":",
"y_col",
"}",
")",
"distances",
",",
"indexes",
"=",
... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | Network.plot | Plot an array of data on a map using matplotlib and Basemap,
automatically matching the data to the Pandana network node positions.
Keyword arguments are passed to the plotting routine.
Parameters
----------
data : pandas.Series
Numeric data with the same length and... | pandana/network.py | def plot(
self, data, bbox=None, plot_type='scatter',
fig_kwargs=None, bmap_kwargs=None, plot_kwargs=None,
cbar_kwargs=None):
"""
Plot an array of data on a map using matplotlib and Basemap,
automatically matching the data to the Pandana network node positions... | def plot(
self, data, bbox=None, plot_type='scatter',
fig_kwargs=None, bmap_kwargs=None, plot_kwargs=None,
cbar_kwargs=None):
"""
Plot an array of data on a map using matplotlib and Basemap,
automatically matching the data to the Pandana network node positions... | [
"Plot",
"an",
"array",
"of",
"data",
"on",
"a",
"map",
"using",
"matplotlib",
"and",
"Basemap",
"automatically",
"matching",
"the",
"data",
"to",
"the",
"Pandana",
"network",
"node",
"positions",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/network.py#L385-L456 | [
"def",
"plot",
"(",
"self",
",",
"data",
",",
"bbox",
"=",
"None",
",",
"plot_type",
"=",
"'scatter'",
",",
"fig_kwargs",
"=",
"None",
",",
"bmap_kwargs",
"=",
"None",
",",
"plot_kwargs",
"=",
"None",
",",
"cbar_kwargs",
"=",
"None",
")",
":",
"from",
... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | Network.set_pois | Set the location of all the pois of this category. The pois are
connected to the closest node in the Pandana network which assumes
no impedance between the location of the variable and the location
of the closest network node.
Parameters
----------
category : string
... | pandana/network.py | def set_pois(self, category, maxdist, maxitems, x_col, y_col):
"""
Set the location of all the pois of this category. The pois are
connected to the closest node in the Pandana network which assumes
no impedance between the location of the variable and the location
of the closest ... | def set_pois(self, category, maxdist, maxitems, x_col, y_col):
"""
Set the location of all the pois of this category. The pois are
connected to the closest node in the Pandana network which assumes
no impedance between the location of the variable and the location
of the closest ... | [
"Set",
"the",
"location",
"of",
"all",
"the",
"pois",
"of",
"this",
"category",
".",
"The",
"pois",
"are",
"connected",
"to",
"the",
"closest",
"node",
"in",
"the",
"Pandana",
"network",
"which",
"assumes",
"no",
"impedance",
"between",
"the",
"location",
... | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/network.py#L458-L493 | [
"def",
"set_pois",
"(",
"self",
",",
"category",
",",
"maxdist",
",",
"maxitems",
",",
"x_col",
",",
"y_col",
")",
":",
"if",
"category",
"not",
"in",
"self",
".",
"poi_category_names",
":",
"self",
".",
"poi_category_names",
".",
"append",
"(",
"category"... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | Network.nearest_pois | Find the distance to the nearest pois from each source node. The
bigger values in this case mean less accessibility.
Parameters
----------
distance : float
The maximum distance to look for pois. This will usually be a
distance unit in meters however if you have ... | pandana/network.py | def nearest_pois(self, distance, category, num_pois=1, max_distance=None,
imp_name=None, include_poi_ids=False):
"""
Find the distance to the nearest pois from each source node. The
bigger values in this case mean less accessibility.
Parameters
----------
... | def nearest_pois(self, distance, category, num_pois=1, max_distance=None,
imp_name=None, include_poi_ids=False):
"""
Find the distance to the nearest pois from each source node. The
bigger values in this case mean less accessibility.
Parameters
----------
... | [
"Find",
"the",
"distance",
"to",
"the",
"nearest",
"pois",
"from",
"each",
"source",
"node",
".",
"The",
"bigger",
"values",
"in",
"this",
"case",
"mean",
"less",
"accessibility",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/network.py#L495-L581 | [
"def",
"nearest_pois",
"(",
"self",
",",
"distance",
",",
"category",
",",
"num_pois",
"=",
"1",
",",
"max_distance",
"=",
"None",
",",
"imp_name",
"=",
"None",
",",
"include_poi_ids",
"=",
"False",
")",
":",
"if",
"max_distance",
"is",
"None",
":",
"max... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | Network.low_connectivity_nodes | Identify nodes that are connected to fewer than some threshold
of other nodes within a given distance.
Parameters
----------
impedance : float
Distance within which to search for other connected nodes. This
will usually be a distance unit in meters however if you... | pandana/network.py | def low_connectivity_nodes(self, impedance, count, imp_name=None):
"""
Identify nodes that are connected to fewer than some threshold
of other nodes within a given distance.
Parameters
----------
impedance : float
Distance within which to search for other con... | def low_connectivity_nodes(self, impedance, count, imp_name=None):
"""
Identify nodes that are connected to fewer than some threshold
of other nodes within a given distance.
Parameters
----------
impedance : float
Distance within which to search for other con... | [
"Identify",
"nodes",
"that",
"are",
"connected",
"to",
"fewer",
"than",
"some",
"threshold",
"of",
"other",
"nodes",
"within",
"a",
"given",
"distance",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/network.py#L583-L618 | [
"def",
"low_connectivity_nodes",
"(",
"self",
",",
"impedance",
",",
"count",
",",
"imp_name",
"=",
"None",
")",
":",
"# set a counter variable on all nodes",
"self",
".",
"set",
"(",
"self",
".",
"node_ids",
".",
"to_series",
"(",
")",
",",
"name",
"=",
"'c... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | pdna_network_from_bbox | Make a Pandana network from a bounding lat/lon box
request to the Overpass API. Distance will be in the default units meters.
Parameters
----------
lat_min, lng_min, lat_max, lng_max : float
bbox : tuple
Bounding box formatted as a 4 element tuple:
(lng_max, lat_min, lng_min, lat_ma... | pandana/loaders/osm.py | def pdna_network_from_bbox(
lat_min=None, lng_min=None, lat_max=None, lng_max=None, bbox=None,
network_type='walk', two_way=True,
timeout=180, memory=None, max_query_area_size=50 * 1000 * 50 * 1000):
"""
Make a Pandana network from a bounding lat/lon box
request to the Overpass API. ... | def pdna_network_from_bbox(
lat_min=None, lng_min=None, lat_max=None, lng_max=None, bbox=None,
network_type='walk', two_way=True,
timeout=180, memory=None, max_query_area_size=50 * 1000 * 50 * 1000):
"""
Make a Pandana network from a bounding lat/lon box
request to the Overpass API. ... | [
"Make",
"a",
"Pandana",
"network",
"from",
"a",
"bounding",
"lat",
"/",
"lon",
"box",
"request",
"to",
"the",
"Overpass",
"API",
".",
"Distance",
"will",
"be",
"in",
"the",
"default",
"units",
"meters",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/loaders/osm.py#L13-L58 | [
"def",
"pdna_network_from_bbox",
"(",
"lat_min",
"=",
"None",
",",
"lng_min",
"=",
"None",
",",
"lat_max",
"=",
"None",
",",
"lng_max",
"=",
"None",
",",
"bbox",
"=",
"None",
",",
"network_type",
"=",
"'walk'",
",",
"two_way",
"=",
"True",
",",
"timeout"... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | process_node | Process a node element entry into a dict suitable for going into
a Pandas DataFrame.
Parameters
----------
e : dict
Returns
-------
node : dict | pandana/loaders/osm.py | def process_node(e):
"""
Process a node element entry into a dict suitable for going into
a Pandas DataFrame.
Parameters
----------
e : dict
Returns
-------
node : dict
"""
uninteresting_tags = {
'source',
'source_ref',
'source:ref',
'history... | def process_node(e):
"""
Process a node element entry into a dict suitable for going into
a Pandas DataFrame.
Parameters
----------
e : dict
Returns
-------
node : dict
"""
uninteresting_tags = {
'source',
'source_ref',
'source:ref',
'history... | [
"Process",
"a",
"node",
"element",
"entry",
"into",
"a",
"dict",
"suitable",
"for",
"going",
"into",
"a",
"Pandas",
"DataFrame",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/loaders/osm.py#L61-L96 | [
"def",
"process_node",
"(",
"e",
")",
":",
"uninteresting_tags",
"=",
"{",
"'source'",
",",
"'source_ref'",
",",
"'source:ref'",
",",
"'history'",
",",
"'attribution'",
",",
"'created_by'",
",",
"'tiger:tlid'",
",",
"'tiger:upload_uuid'",
",",
"}",
"node",
"=",
... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | make_osm_query | Make a request to OSM and return the parsed JSON.
Parameters
----------
query : str
A string in the Overpass QL format.
Returns
-------
data : dict | pandana/loaders/osm.py | def make_osm_query(query):
"""
Make a request to OSM and return the parsed JSON.
Parameters
----------
query : str
A string in the Overpass QL format.
Returns
-------
data : dict
"""
osm_url = 'http://www.overpass-api.de/api/interpreter'
req = requests.get(osm_url,... | def make_osm_query(query):
"""
Make a request to OSM and return the parsed JSON.
Parameters
----------
query : str
A string in the Overpass QL format.
Returns
-------
data : dict
"""
osm_url = 'http://www.overpass-api.de/api/interpreter'
req = requests.get(osm_url,... | [
"Make",
"a",
"request",
"to",
"OSM",
"and",
"return",
"the",
"parsed",
"JSON",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/loaders/osm.py#L99-L117 | [
"def",
"make_osm_query",
"(",
"query",
")",
":",
"osm_url",
"=",
"'http://www.overpass-api.de/api/interpreter'",
"req",
"=",
"requests",
".",
"get",
"(",
"osm_url",
",",
"params",
"=",
"{",
"'data'",
":",
"query",
"}",
")",
"req",
".",
"raise_for_status",
"(",... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | build_node_query | Build the string for a node-based OSM query.
Parameters
----------
lat_min, lng_min, lat_max, lng_max : float
tags : str or list of str, optional
Node tags that will be used to filter the search.
See http://wiki.openstreetmap.org/wiki/Overpass_API/Language_Guide
for information ... | pandana/loaders/osm.py | def build_node_query(lat_min, lng_min, lat_max, lng_max, tags=None):
"""
Build the string for a node-based OSM query.
Parameters
----------
lat_min, lng_min, lat_max, lng_max : float
tags : str or list of str, optional
Node tags that will be used to filter the search.
See http:/... | def build_node_query(lat_min, lng_min, lat_max, lng_max, tags=None):
"""
Build the string for a node-based OSM query.
Parameters
----------
lat_min, lng_min, lat_max, lng_max : float
tags : str or list of str, optional
Node tags that will be used to filter the search.
See http:/... | [
"Build",
"the",
"string",
"for",
"a",
"node",
"-",
"based",
"OSM",
"query",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/loaders/osm.py#L120-L157 | [
"def",
"build_node_query",
"(",
"lat_min",
",",
"lng_min",
",",
"lat_max",
",",
"lng_max",
",",
"tags",
"=",
"None",
")",
":",
"if",
"tags",
"is",
"not",
"None",
":",
"if",
"isinstance",
"(",
"tags",
",",
"str",
")",
":",
"tags",
"=",
"[",
"tags",
... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | node_query | Search for OSM nodes within a bounding box that match given tags.
Parameters
----------
lat_min, lng_min, lat_max, lng_max : float
tags : str or list of str, optional
Node tags that will be used to filter the search.
See http://wiki.openstreetmap.org/wiki/Overpass_API/Language_Guide
... | pandana/loaders/osm.py | def node_query(lat_min, lng_min, lat_max, lng_max, tags=None):
"""
Search for OSM nodes within a bounding box that match given tags.
Parameters
----------
lat_min, lng_min, lat_max, lng_max : float
tags : str or list of str, optional
Node tags that will be used to filter the search.
... | def node_query(lat_min, lng_min, lat_max, lng_max, tags=None):
"""
Search for OSM nodes within a bounding box that match given tags.
Parameters
----------
lat_min, lng_min, lat_max, lng_max : float
tags : str or list of str, optional
Node tags that will be used to filter the search.
... | [
"Search",
"for",
"OSM",
"nodes",
"within",
"a",
"bounding",
"box",
"that",
"match",
"given",
"tags",
"."
] | UDST/pandana | python | https://github.com/UDST/pandana/blob/961a7ef8d3b0144b190cb60bbd61845fca6fb314/pandana/loaders/osm.py#L160-L189 | [
"def",
"node_query",
"(",
"lat_min",
",",
"lng_min",
",",
"lat_max",
",",
"lng_max",
",",
"tags",
"=",
"None",
")",
":",
"node_data",
"=",
"make_osm_query",
"(",
"build_node_query",
"(",
"lat_min",
",",
"lng_min",
",",
"lat_max",
",",
"lng_max",
",",
"tags... | 961a7ef8d3b0144b190cb60bbd61845fca6fb314 |
test | equal | Shortcut function for ``unittest.TestCase.assertEqual()``.
Arguments:
x (mixed)
y (mixed)
Raises:
AssertionError: in case of assertion error.
Returns:
bool | pook/assertion.py | def equal(x, y):
"""
Shortcut function for ``unittest.TestCase.assertEqual()``.
Arguments:
x (mixed)
y (mixed)
Raises:
AssertionError: in case of assertion error.
Returns:
bool
"""
if PY_3:
return test_case().assertEqual(x, y) or True
assert x ... | def equal(x, y):
"""
Shortcut function for ``unittest.TestCase.assertEqual()``.
Arguments:
x (mixed)
y (mixed)
Raises:
AssertionError: in case of assertion error.
Returns:
bool
"""
if PY_3:
return test_case().assertEqual(x, y) or True
assert x ... | [
"Shortcut",
"function",
"for",
"unittest",
".",
"TestCase",
".",
"assertEqual",
"()",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/assertion.py#L22-L39 | [
"def",
"equal",
"(",
"x",
",",
"y",
")",
":",
"if",
"PY_3",
":",
"return",
"test_case",
"(",
")",
".",
"assertEqual",
"(",
"x",
",",
"y",
")",
"or",
"True",
"assert",
"x",
"==",
"y"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | matches | Tries to match a regular expression value ``x`` against ``y``.
Aliast``unittest.TestCase.assertEqual()``
Arguments:
x (regex|str): regular expression to test.
y (str): value to match.
regex_expr (bool): enables regex string based expression matching.
Raises:
AssertionError:... | pook/assertion.py | def matches(x, y, regex_expr=False):
"""
Tries to match a regular expression value ``x`` against ``y``.
Aliast``unittest.TestCase.assertEqual()``
Arguments:
x (regex|str): regular expression to test.
y (str): value to match.
regex_expr (bool): enables regex string based expressi... | def matches(x, y, regex_expr=False):
"""
Tries to match a regular expression value ``x`` against ``y``.
Aliast``unittest.TestCase.assertEqual()``
Arguments:
x (regex|str): regular expression to test.
y (str): value to match.
regex_expr (bool): enables regex string based expressi... | [
"Tries",
"to",
"match",
"a",
"regular",
"expression",
"value",
"x",
"against",
"y",
".",
"Aliast",
"unittest",
".",
"TestCase",
".",
"assertEqual",
"()"
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/assertion.py#L42-L72 | [
"def",
"matches",
"(",
"x",
",",
"y",
",",
"regex_expr",
"=",
"False",
")",
":",
"# Parse regex expression, if needed",
"x",
"=",
"strip_regex",
"(",
"x",
")",
"if",
"regex_expr",
"and",
"isregex_expr",
"(",
"x",
")",
"else",
"x",
"# Run regex assertion",
"i... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | isregex_expr | Returns ``True`` is the given expression value is a regular expression
like string with prefix ``re/`` and suffix ``/``, otherwise ``False``.
Arguments:
expr (mixed): expression value to test.
Returns:
bool | pook/regex.py | def isregex_expr(expr):
"""
Returns ``True`` is the given expression value is a regular expression
like string with prefix ``re/`` and suffix ``/``, otherwise ``False``.
Arguments:
expr (mixed): expression value to test.
Returns:
bool
"""
if not isinstance(expr, str):
... | def isregex_expr(expr):
"""
Returns ``True`` is the given expression value is a regular expression
like string with prefix ``re/`` and suffix ``/``, otherwise ``False``.
Arguments:
expr (mixed): expression value to test.
Returns:
bool
"""
if not isinstance(expr, str):
... | [
"Returns",
"True",
"is",
"the",
"given",
"expression",
"value",
"is",
"a",
"regular",
"expression",
"like",
"string",
"with",
"prefix",
"re",
"/",
"and",
"suffix",
"/",
"otherwise",
"False",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/regex.py#L7-L25 | [
"def",
"isregex_expr",
"(",
"expr",
")",
":",
"if",
"not",
"isinstance",
"(",
"expr",
",",
"str",
")",
":",
"return",
"False",
"return",
"all",
"(",
"[",
"len",
"(",
"expr",
")",
">",
"3",
",",
"expr",
".",
"startswith",
"(",
"'re/'",
")",
",",
"... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | isregex | Returns ``True`` if the input argument object is a native
regular expression object, otherwise ``False``.
Arguments:
value (mixed): input value to test.
Returns:
bool | pook/regex.py | def isregex(value):
"""
Returns ``True`` if the input argument object is a native
regular expression object, otherwise ``False``.
Arguments:
value (mixed): input value to test.
Returns:
bool
"""
if not value:
return False
return any((isregex_expr(value), isinsta... | def isregex(value):
"""
Returns ``True`` if the input argument object is a native
regular expression object, otherwise ``False``.
Arguments:
value (mixed): input value to test.
Returns:
bool
"""
if not value:
return False
return any((isregex_expr(value), isinsta... | [
"Returns",
"True",
"if",
"the",
"input",
"argument",
"object",
"is",
"a",
"native",
"regular",
"expression",
"object",
"otherwise",
"False",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/regex.py#L28-L41 | [
"def",
"isregex",
"(",
"value",
")",
":",
"if",
"not",
"value",
":",
"return",
"False",
"return",
"any",
"(",
"(",
"isregex_expr",
"(",
"value",
")",
",",
"isinstance",
"(",
"value",
",",
"retype",
")",
")",
")"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | BaseMatcher.compare | Compares two values with regular expression matching support.
Arguments:
value (mixed): value to compare.
expectation (mixed): value to match.
regex_expr (bool, optional): enables string based regex matching.
Returns:
bool | pook/matchers/base.py | def compare(self, value, expectation, regex_expr=False):
"""
Compares two values with regular expression matching support.
Arguments:
value (mixed): value to compare.
expectation (mixed): value to match.
regex_expr (bool, optional): enables string based regex... | def compare(self, value, expectation, regex_expr=False):
"""
Compares two values with regular expression matching support.
Arguments:
value (mixed): value to compare.
expectation (mixed): value to match.
regex_expr (bool, optional): enables string based regex... | [
"Compares",
"two",
"values",
"with",
"regular",
"expression",
"matching",
"support",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/matchers/base.py#L47-L59 | [
"def",
"compare",
"(",
"self",
",",
"value",
",",
"expectation",
",",
"regex_expr",
"=",
"False",
")",
":",
"return",
"compare",
"(",
"value",
",",
"expectation",
",",
"regex_expr",
"=",
"regex_expr",
")"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | fluent | Simple function decorator allowing easy method chaining.
Arguments:
fn (function): target function to decorate. | pook/decorators.py | def fluent(fn):
"""
Simple function decorator allowing easy method chaining.
Arguments:
fn (function): target function to decorate.
"""
@functools.wraps(fn)
def wrapper(self, *args, **kw):
# Trigger method proxy
result = fn(self, *args, **kw)
# Return self instan... | def fluent(fn):
"""
Simple function decorator allowing easy method chaining.
Arguments:
fn (function): target function to decorate.
"""
@functools.wraps(fn)
def wrapper(self, *args, **kw):
# Trigger method proxy
result = fn(self, *args, **kw)
# Return self instan... | [
"Simple",
"function",
"decorator",
"allowing",
"easy",
"method",
"chaining",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/decorators.py#L4-L17 | [
"def",
"fluent",
"(",
"fn",
")",
":",
"@",
"functools",
".",
"wraps",
"(",
"fn",
")",
"def",
"wrapper",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kw",
")",
":",
"# Trigger method proxy",
"result",
"=",
"fn",
"(",
"self",
",",
"*",
"args",
",... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | compare | Compares an string or regular expression againast a given value.
Arguments:
expr (str|regex): string or regular expression value to compare.
value (str): value to compare against to.
regex_expr (bool, optional): enables string based regex matching.
Raises:
AssertionError: in ca... | pook/compare.py | def compare(expr, value, regex_expr=False):
"""
Compares an string or regular expression againast a given value.
Arguments:
expr (str|regex): string or regular expression value to compare.
value (str): value to compare against to.
regex_expr (bool, optional): enables string based re... | def compare(expr, value, regex_expr=False):
"""
Compares an string or regular expression againast a given value.
Arguments:
expr (str|regex): string or regular expression value to compare.
value (str): value to compare against to.
regex_expr (bool, optional): enables string based re... | [
"Compares",
"an",
"string",
"or",
"regular",
"expression",
"againast",
"a",
"given",
"value",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/compare.py#L26-L60 | [
"def",
"compare",
"(",
"expr",
",",
"value",
",",
"regex_expr",
"=",
"False",
")",
":",
"# Strict equality comparison",
"if",
"expr",
"==",
"value",
":",
"return",
"True",
"# Infer negate expression to match, if needed",
"negate",
"=",
"False",
"if",
"isinstance",
... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | trigger_methods | Triggers specific class methods using a simple reflection
mechanism based on the given input dictionary params.
Arguments:
instance (object): target instance to dynamically trigger methods.
args (iterable): input arguments to trigger objects to
Returns:
None | pook/helpers.py | def trigger_methods(instance, args):
""""
Triggers specific class methods using a simple reflection
mechanism based on the given input dictionary params.
Arguments:
instance (object): target instance to dynamically trigger methods.
args (iterable): input arguments to trigger objects to
... | def trigger_methods(instance, args):
""""
Triggers specific class methods using a simple reflection
mechanism based on the given input dictionary params.
Arguments:
instance (object): target instance to dynamically trigger methods.
args (iterable): input arguments to trigger objects to
... | [
"Triggers",
"specific",
"class",
"methods",
"using",
"a",
"simple",
"reflection",
"mechanism",
"based",
"on",
"the",
"given",
"input",
"dictionary",
"params",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/helpers.py#L5-L43 | [
"def",
"trigger_methods",
"(",
"instance",
",",
"args",
")",
":",
"# Start the magic",
"for",
"name",
"in",
"sorted",
"(",
"args",
")",
":",
"value",
"=",
"args",
"[",
"name",
"]",
"target",
"=",
"instance",
"# If response attibutes",
"if",
"name",
".",
"s... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | MatcherEngine.match | Match the given HTTP request instance against the registered
matcher functions in the current engine.
Arguments:
request (pook.Request): outgoing request to match.
Returns:
tuple(bool, list[Exception]): ``True`` if all matcher tests
passes, otherwise ``F... | pook/matcher.py | def match(self, request):
"""
Match the given HTTP request instance against the registered
matcher functions in the current engine.
Arguments:
request (pook.Request): outgoing request to match.
Returns:
tuple(bool, list[Exception]): ``True`` if all match... | def match(self, request):
"""
Match the given HTTP request instance against the registered
matcher functions in the current engine.
Arguments:
request (pook.Request): outgoing request to match.
Returns:
tuple(bool, list[Exception]): ``True`` if all match... | [
"Match",
"the",
"given",
"HTTP",
"request",
"instance",
"against",
"the",
"registered",
"matcher",
"functions",
"in",
"the",
"current",
"engine",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/matcher.py#L23-L46 | [
"def",
"match",
"(",
"self",
",",
"request",
")",
":",
"errors",
"=",
"[",
"]",
"def",
"match",
"(",
"matcher",
")",
":",
"try",
":",
"return",
"matcher",
".",
"match",
"(",
"request",
")",
"except",
"Exception",
"as",
"err",
":",
"err",
"=",
"'{}:... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | get | Returns a matcher instance by class or alias name.
Arguments:
name (str): matcher class name or alias.
Returns:
matcher: found matcher instance, otherwise ``None``. | pook/matchers/api.py | def get(name):
"""
Returns a matcher instance by class or alias name.
Arguments:
name (str): matcher class name or alias.
Returns:
matcher: found matcher instance, otherwise ``None``.
"""
for matcher in matchers:
if matcher.__name__ == name or getattr(matcher, 'name', N... | def get(name):
"""
Returns a matcher instance by class or alias name.
Arguments:
name (str): matcher class name or alias.
Returns:
matcher: found matcher instance, otherwise ``None``.
"""
for matcher in matchers:
if matcher.__name__ == name or getattr(matcher, 'name', N... | [
"Returns",
"a",
"matcher",
"instance",
"by",
"class",
"or",
"alias",
"name",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/matchers/api.py#L58-L70 | [
"def",
"get",
"(",
"name",
")",
":",
"for",
"matcher",
"in",
"matchers",
":",
"if",
"matcher",
".",
"__name__",
"==",
"name",
"or",
"getattr",
"(",
"matcher",
",",
"'name'",
",",
"None",
")",
"==",
"name",
":",
"return",
"matcher"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | init | Initializes a matcher instance passing variadic arguments to
its constructor. Acts as a delegator proxy.
Arguments:
name (str): matcher class name or alias to execute.
*args (mixed): variadic argument
Returns:
matcher: matcher instance.
Raises:
ValueError: if matcher w... | pook/matchers/api.py | def init(name, *args):
"""
Initializes a matcher instance passing variadic arguments to
its constructor. Acts as a delegator proxy.
Arguments:
name (str): matcher class name or alias to execute.
*args (mixed): variadic argument
Returns:
matcher: matcher instance.
Raise... | def init(name, *args):
"""
Initializes a matcher instance passing variadic arguments to
its constructor. Acts as a delegator proxy.
Arguments:
name (str): matcher class name or alias to execute.
*args (mixed): variadic argument
Returns:
matcher: matcher instance.
Raise... | [
"Initializes",
"a",
"matcher",
"instance",
"passing",
"variadic",
"arguments",
"to",
"its",
"constructor",
".",
"Acts",
"as",
"a",
"delegator",
"proxy",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/matchers/api.py#L73-L91 | [
"def",
"init",
"(",
"name",
",",
"*",
"args",
")",
":",
"matcher",
"=",
"get",
"(",
"name",
")",
"if",
"not",
"matcher",
":",
"raise",
"ValueError",
"(",
"'Cannot find matcher: {}'",
".",
"format",
"(",
"name",
")",
")",
"return",
"matcher",
"(",
"*",
... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Response.header | Defines a new response header.
Alias to ``Response.header()``.
Arguments:
header (str): header name.
value (str): header value.
Returns:
self: ``pook.Response`` current instance. | pook/response.py | def header(self, key, value):
"""
Defines a new response header.
Alias to ``Response.header()``.
Arguments:
header (str): header name.
value (str): header value.
Returns:
self: ``pook.Response`` current instance.
"""
if type(k... | def header(self, key, value):
"""
Defines a new response header.
Alias to ``Response.header()``.
Arguments:
header (str): header name.
value (str): header value.
Returns:
self: ``pook.Response`` current instance.
"""
if type(k... | [
"Defines",
"a",
"new",
"response",
"header",
".",
"Alias",
"to",
"Response",
".",
"header",
"()",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/response.py#L50-L66 | [
"def",
"header",
"(",
"self",
",",
"key",
",",
"value",
")",
":",
"if",
"type",
"(",
"key",
")",
"is",
"tuple",
":",
"key",
",",
"value",
"=",
"str",
"(",
"key",
"[",
"0",
"]",
")",
",",
"key",
"[",
"1",
"]",
"headers",
"=",
"{",
"key",
":"... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Response.body | Defines response body data.
Arguments:
body (str|bytes): response body to use.
Returns:
self: ``pook.Response`` current instance. | pook/response.py | def body(self, body):
"""
Defines response body data.
Arguments:
body (str|bytes): response body to use.
Returns:
self: ``pook.Response`` current instance.
"""
if isinstance(body, bytes):
body = body.decode('utf-8')
self._bod... | def body(self, body):
"""
Defines response body data.
Arguments:
body (str|bytes): response body to use.
Returns:
self: ``pook.Response`` current instance.
"""
if isinstance(body, bytes):
body = body.decode('utf-8')
self._bod... | [
"Defines",
"response",
"body",
"data",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/response.py#L148-L161 | [
"def",
"body",
"(",
"self",
",",
"body",
")",
":",
"if",
"isinstance",
"(",
"body",
",",
"bytes",
")",
":",
"body",
"=",
"body",
".",
"decode",
"(",
"'utf-8'",
")",
"self",
".",
"_body",
"=",
"body"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Response.json | Defines the mock response JSON body.
Arguments:
data (dict|list|str): JSON body data.
Returns:
self: ``pook.Response`` current instance. | pook/response.py | def json(self, data):
"""
Defines the mock response JSON body.
Arguments:
data (dict|list|str): JSON body data.
Returns:
self: ``pook.Response`` current instance.
"""
self._headers['Content-Type'] = 'application/json'
if not isinstance(da... | def json(self, data):
"""
Defines the mock response JSON body.
Arguments:
data (dict|list|str): JSON body data.
Returns:
self: ``pook.Response`` current instance.
"""
self._headers['Content-Type'] = 'application/json'
if not isinstance(da... | [
"Defines",
"the",
"mock",
"response",
"JSON",
"body",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/response.py#L164-L177 | [
"def",
"json",
"(",
"self",
",",
"data",
")",
":",
"self",
".",
"_headers",
"[",
"'Content-Type'",
"]",
"=",
"'application/json'",
"if",
"not",
"isinstance",
"(",
"data",
",",
"str",
")",
":",
"data",
"=",
"json",
".",
"dumps",
"(",
"data",
",",
"ind... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | HTTPHeaderDict.set | Sets a header field with the given value, removing
previous values.
Usage::
headers = HTTPHeaderDict(foo='bar')
headers.set('Foo', 'baz')
headers['foo']
> 'baz' | pook/headers.py | def set(self, key, val):
"""
Sets a header field with the given value, removing
previous values.
Usage::
headers = HTTPHeaderDict(foo='bar')
headers.set('Foo', 'baz')
headers['foo']
> 'baz'
"""
key_lower = key.lower()
... | def set(self, key, val):
"""
Sets a header field with the given value, removing
previous values.
Usage::
headers = HTTPHeaderDict(foo='bar')
headers.set('Foo', 'baz')
headers['foo']
> 'baz'
"""
key_lower = key.lower()
... | [
"Sets",
"a",
"header",
"field",
"with",
"the",
"given",
"value",
"removing",
"previous",
"values",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/headers.py#L141-L158 | [
"def",
"set",
"(",
"self",
",",
"key",
",",
"val",
")",
":",
"key_lower",
"=",
"key",
".",
"lower",
"(",
")",
"new_vals",
"=",
"key",
",",
"val",
"# Keep the common case aka no item present as fast as possible",
"vals",
"=",
"self",
".",
"_container",
".",
"... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | _append_funcs | Helper function to append functions into a given list.
Arguments:
target (list): receptor list to append functions.
items (iterable): iterable that yields elements to append. | pook/mock.py | def _append_funcs(target, items):
"""
Helper function to append functions into a given list.
Arguments:
target (list): receptor list to append functions.
items (iterable): iterable that yields elements to append.
"""
[target.append(item) for item in items
if isfunction(item) or... | def _append_funcs(target, items):
"""
Helper function to append functions into a given list.
Arguments:
target (list): receptor list to append functions.
items (iterable): iterable that yields elements to append.
"""
[target.append(item) for item in items
if isfunction(item) or... | [
"Helper",
"function",
"to",
"append",
"functions",
"into",
"a",
"given",
"list",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L16-L25 | [
"def",
"_append_funcs",
"(",
"target",
",",
"items",
")",
":",
"[",
"target",
".",
"append",
"(",
"item",
")",
"for",
"item",
"in",
"items",
"if",
"isfunction",
"(",
"item",
")",
"or",
"ismethod",
"(",
"item",
")",
"]"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | _trigger_request | Triggers request mock definition methods dynamically based on input
keyword arguments passed to `pook.Mock` constructor.
This is used to provide a more Pythonic interface vs chainable API
approach. | pook/mock.py | def _trigger_request(instance, request):
"""
Triggers request mock definition methods dynamically based on input
keyword arguments passed to `pook.Mock` constructor.
This is used to provide a more Pythonic interface vs chainable API
approach.
"""
if not isinstance(request, Request):
... | def _trigger_request(instance, request):
"""
Triggers request mock definition methods dynamically based on input
keyword arguments passed to `pook.Mock` constructor.
This is used to provide a more Pythonic interface vs chainable API
approach.
"""
if not isinstance(request, Request):
... | [
"Triggers",
"request",
"mock",
"definition",
"methods",
"dynamically",
"based",
"on",
"input",
"keyword",
"arguments",
"passed",
"to",
"pook",
".",
"Mock",
"constructor",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L28-L42 | [
"def",
"_trigger_request",
"(",
"instance",
",",
"request",
")",
":",
"if",
"not",
"isinstance",
"(",
"request",
",",
"Request",
")",
":",
"raise",
"TypeError",
"(",
"'request must be instance of pook.Request'",
")",
"# Register request matchers",
"for",
"key",
"in"... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.url | Defines the mock URL to match.
It can be a full URL with path and query params.
Protocol schema is optional, defaults to ``http://``.
Arguments:
url (str): mock URL to match. E.g: ``server.com/api``.
Returns:
self: current Mock instance. | pook/mock.py | def url(self, url):
"""
Defines the mock URL to match.
It can be a full URL with path and query params.
Protocol schema is optional, defaults to ``http://``.
Arguments:
url (str): mock URL to match. E.g: ``server.com/api``.
Returns:
self: curren... | def url(self, url):
"""
Defines the mock URL to match.
It can be a full URL with path and query params.
Protocol schema is optional, defaults to ``http://``.
Arguments:
url (str): mock URL to match. E.g: ``server.com/api``.
Returns:
self: curren... | [
"Defines",
"the",
"mock",
"URL",
"to",
"match",
".",
"It",
"can",
"be",
"a",
"full",
"URL",
"with",
"path",
"and",
"query",
"params",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L138-L152 | [
"def",
"url",
"(",
"self",
",",
"url",
")",
":",
"self",
".",
"_request",
".",
"url",
"=",
"url",
"self",
".",
"add_matcher",
"(",
"matcher",
"(",
"'URLMatcher'",
",",
"url",
")",
")"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.method | Defines the HTTP method to match.
Use ``*`` to match any method.
Arguments:
method (str): method value to match. E.g: ``GET``.
Returns:
self: current Mock instance. | pook/mock.py | def method(self, method):
"""
Defines the HTTP method to match.
Use ``*`` to match any method.
Arguments:
method (str): method value to match. E.g: ``GET``.
Returns:
self: current Mock instance.
"""
self._request.method = method
s... | def method(self, method):
"""
Defines the HTTP method to match.
Use ``*`` to match any method.
Arguments:
method (str): method value to match. E.g: ``GET``.
Returns:
self: current Mock instance.
"""
self._request.method = method
s... | [
"Defines",
"the",
"HTTP",
"method",
"to",
"match",
".",
"Use",
"*",
"to",
"match",
"any",
"method",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L155-L167 | [
"def",
"method",
"(",
"self",
",",
"method",
")",
":",
"self",
".",
"_request",
".",
"method",
"=",
"method",
"self",
".",
"add_matcher",
"(",
"matcher",
"(",
"'MethodMatcher'",
",",
"method",
")",
")"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.path | Defines a URL path to match.
Only call this method if the URL has no path already defined.
Arguments:
path (str): URL path value to match. E.g: ``/api/users``.
Returns:
self: current Mock instance. | pook/mock.py | def path(self, path):
"""
Defines a URL path to match.
Only call this method if the URL has no path already defined.
Arguments:
path (str): URL path value to match. E.g: ``/api/users``.
Returns:
self: current Mock instance.
"""
url = fur... | def path(self, path):
"""
Defines a URL path to match.
Only call this method if the URL has no path already defined.
Arguments:
path (str): URL path value to match. E.g: ``/api/users``.
Returns:
self: current Mock instance.
"""
url = fur... | [
"Defines",
"a",
"URL",
"path",
"to",
"match",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L170-L185 | [
"def",
"path",
"(",
"self",
",",
"path",
")",
":",
"url",
"=",
"furl",
"(",
"self",
".",
"_request",
".",
"rawurl",
")",
"url",
".",
"path",
"=",
"path",
"self",
".",
"_request",
".",
"url",
"=",
"url",
".",
"url",
"self",
".",
"add_matcher",
"("... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.header | Defines a URL path to match.
Only call this method if the URL has no path already defined.
Arguments:
path (str): URL path value to match. E.g: ``/api/users``.
Returns:
self: current Mock instance. | pook/mock.py | def header(self, name, value):
"""
Defines a URL path to match.
Only call this method if the URL has no path already defined.
Arguments:
path (str): URL path value to match. E.g: ``/api/users``.
Returns:
self: current Mock instance.
"""
... | def header(self, name, value):
"""
Defines a URL path to match.
Only call this method if the URL has no path already defined.
Arguments:
path (str): URL path value to match. E.g: ``/api/users``.
Returns:
self: current Mock instance.
"""
... | [
"Defines",
"a",
"URL",
"path",
"to",
"match",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L188-L202 | [
"def",
"header",
"(",
"self",
",",
"name",
",",
"value",
")",
":",
"headers",
"=",
"{",
"name",
":",
"value",
"}",
"self",
".",
"_request",
".",
"headers",
"=",
"headers",
"self",
".",
"add_matcher",
"(",
"matcher",
"(",
"'HeadersMatcher'",
",",
"heade... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.headers | Defines a dictionary of arguments.
Header keys are case insensitive.
Arguments:
headers (dict): headers to match.
**headers (dict): headers to match as variadic keyword arguments.
Returns:
self: current Mock instance. | pook/mock.py | def headers(self, headers=None, **kw):
"""
Defines a dictionary of arguments.
Header keys are case insensitive.
Arguments:
headers (dict): headers to match.
**headers (dict): headers to match as variadic keyword arguments.
Returns:
self: cur... | def headers(self, headers=None, **kw):
"""
Defines a dictionary of arguments.
Header keys are case insensitive.
Arguments:
headers (dict): headers to match.
**headers (dict): headers to match as variadic keyword arguments.
Returns:
self: cur... | [
"Defines",
"a",
"dictionary",
"of",
"arguments",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L205-L220 | [
"def",
"headers",
"(",
"self",
",",
"headers",
"=",
"None",
",",
"*",
"*",
"kw",
")",
":",
"headers",
"=",
"kw",
"if",
"kw",
"else",
"headers",
"self",
".",
"_request",
".",
"headers",
"=",
"headers",
"self",
".",
"add_matcher",
"(",
"matcher",
"(",
... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.header_present | Defines a new header matcher expectation that must be present in the
outgoing request in order to be satisfied, no matter what value it
hosts.
Header keys are case insensitive.
Arguments:
*names (str): header or headers names to match.
Returns:
self: cu... | pook/mock.py | def header_present(self, *names):
"""
Defines a new header matcher expectation that must be present in the
outgoing request in order to be satisfied, no matter what value it
hosts.
Header keys are case insensitive.
Arguments:
*names (str): header or headers ... | def header_present(self, *names):
"""
Defines a new header matcher expectation that must be present in the
outgoing request in order to be satisfied, no matter what value it
hosts.
Header keys are case insensitive.
Arguments:
*names (str): header or headers ... | [
"Defines",
"a",
"new",
"header",
"matcher",
"expectation",
"that",
"must",
"be",
"present",
"in",
"the",
"outgoing",
"request",
"in",
"order",
"to",
"be",
"satisfied",
"no",
"matter",
"what",
"value",
"it",
"hosts",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L223-L244 | [
"def",
"header_present",
"(",
"self",
",",
"*",
"names",
")",
":",
"for",
"name",
"in",
"names",
":",
"headers",
"=",
"{",
"name",
":",
"re",
".",
"compile",
"(",
"'(.*)'",
")",
"}",
"self",
".",
"add_matcher",
"(",
"matcher",
"(",
"'HeadersMatcher'",
... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.headers_present | Defines a list of headers that must be present in the
outgoing request in order to satisfy the matcher, no matter what value
the headers hosts.
Header keys are case insensitive.
Arguments:
headers (list|tuple): header keys to match.
Returns:
self: curre... | pook/mock.py | def headers_present(self, headers):
"""
Defines a list of headers that must be present in the
outgoing request in order to satisfy the matcher, no matter what value
the headers hosts.
Header keys are case insensitive.
Arguments:
headers (list|tuple): header ... | def headers_present(self, headers):
"""
Defines a list of headers that must be present in the
outgoing request in order to satisfy the matcher, no matter what value
the headers hosts.
Header keys are case insensitive.
Arguments:
headers (list|tuple): header ... | [
"Defines",
"a",
"list",
"of",
"headers",
"that",
"must",
"be",
"present",
"in",
"the",
"outgoing",
"request",
"in",
"order",
"to",
"satisfy",
"the",
"matcher",
"no",
"matter",
"what",
"value",
"the",
"headers",
"hosts",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L247-L267 | [
"def",
"headers_present",
"(",
"self",
",",
"headers",
")",
":",
"headers",
"=",
"{",
"name",
":",
"re",
".",
"compile",
"(",
"'(.*)'",
")",
"for",
"name",
"in",
"headers",
"}",
"self",
".",
"add_matcher",
"(",
"matcher",
"(",
"'HeadersMatcher'",
",",
... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.content | Defines the ``Content-Type`` outgoing header value to match.
You can pass one of the following type aliases instead of the full
MIME type representation:
- ``json`` = ``application/json``
- ``xml`` = ``application/xml``
- ``html`` = ``text/html``
- ``text`` = ``text/pla... | pook/mock.py | def content(self, value):
"""
Defines the ``Content-Type`` outgoing header value to match.
You can pass one of the following type aliases instead of the full
MIME type representation:
- ``json`` = ``application/json``
- ``xml`` = ``application/xml``
- ``html`` =... | def content(self, value):
"""
Defines the ``Content-Type`` outgoing header value to match.
You can pass one of the following type aliases instead of the full
MIME type representation:
- ``json`` = ``application/json``
- ``xml`` = ``application/xml``
- ``html`` =... | [
"Defines",
"the",
"Content",
"-",
"Type",
"outgoing",
"header",
"value",
"to",
"match",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L294-L317 | [
"def",
"content",
"(",
"self",
",",
"value",
")",
":",
"header",
"=",
"{",
"'Content-Type'",
":",
"TYPES",
".",
"get",
"(",
"value",
",",
"value",
")",
"}",
"self",
".",
"_request",
".",
"headers",
"=",
"header",
"self",
".",
"add_matcher",
"(",
"mat... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.params | Defines a set of URL query params to match.
Arguments:
params (dict): set of params to match.
Returns:
self: current Mock instance. | pook/mock.py | def params(self, params):
"""
Defines a set of URL query params to match.
Arguments:
params (dict): set of params to match.
Returns:
self: current Mock instance.
"""
url = furl(self._request.rawurl)
url = url.add(params)
self._req... | def params(self, params):
"""
Defines a set of URL query params to match.
Arguments:
params (dict): set of params to match.
Returns:
self: current Mock instance.
"""
url = furl(self._request.rawurl)
url = url.add(params)
self._req... | [
"Defines",
"a",
"set",
"of",
"URL",
"query",
"params",
"to",
"match",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L347-L360 | [
"def",
"params",
"(",
"self",
",",
"params",
")",
":",
"url",
"=",
"furl",
"(",
"self",
".",
"_request",
".",
"rawurl",
")",
"url",
"=",
"url",
".",
"add",
"(",
"params",
")",
"self",
".",
"_request",
".",
"url",
"=",
"url",
".",
"url",
"self",
... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.body | Defines the body data to match.
``body`` argument can be a ``str``, ``binary`` or a regular expression.
Arguments:
body (str|binary|regex): body data to match.
Returns:
self: current Mock instance. | pook/mock.py | def body(self, body):
"""
Defines the body data to match.
``body`` argument can be a ``str``, ``binary`` or a regular expression.
Arguments:
body (str|binary|regex): body data to match.
Returns:
self: current Mock instance.
"""
self._req... | def body(self, body):
"""
Defines the body data to match.
``body`` argument can be a ``str``, ``binary`` or a regular expression.
Arguments:
body (str|binary|regex): body data to match.
Returns:
self: current Mock instance.
"""
self._req... | [
"Defines",
"the",
"body",
"data",
"to",
"match",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L363-L376 | [
"def",
"body",
"(",
"self",
",",
"body",
")",
":",
"self",
".",
"_request",
".",
"body",
"=",
"body",
"self",
".",
"add_matcher",
"(",
"matcher",
"(",
"'BodyMatcher'",
",",
"body",
")",
")"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.json | Defines the JSON body to match.
``json`` argument can be an JSON string, a JSON serializable
Python structure, such as a ``dict`` or ``list`` or it can be
a regular expression used to match the body.
Arguments:
json (str|dict|list|regex): body JSON to match.
Return... | pook/mock.py | def json(self, json):
"""
Defines the JSON body to match.
``json`` argument can be an JSON string, a JSON serializable
Python structure, such as a ``dict`` or ``list`` or it can be
a regular expression used to match the body.
Arguments:
json (str|dict|list|r... | def json(self, json):
"""
Defines the JSON body to match.
``json`` argument can be an JSON string, a JSON serializable
Python structure, such as a ``dict`` or ``list`` or it can be
a regular expression used to match the body.
Arguments:
json (str|dict|list|r... | [
"Defines",
"the",
"JSON",
"body",
"to",
"match",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L379-L394 | [
"def",
"json",
"(",
"self",
",",
"json",
")",
":",
"self",
".",
"_request",
".",
"json",
"=",
"json",
"self",
".",
"add_matcher",
"(",
"matcher",
"(",
"'JSONMatcher'",
",",
"json",
")",
")"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.xml | Defines a XML body value to match.
Arguments:
xml (str|regex): body XML to match.
Returns:
self: current Mock instance. | pook/mock.py | def xml(self, xml):
"""
Defines a XML body value to match.
Arguments:
xml (str|regex): body XML to match.
Returns:
self: current Mock instance.
"""
self._request.xml = xml
self.add_matcher(matcher('XMLMatcher', xml)) | def xml(self, xml):
"""
Defines a XML body value to match.
Arguments:
xml (str|regex): body XML to match.
Returns:
self: current Mock instance.
"""
self._request.xml = xml
self.add_matcher(matcher('XMLMatcher', xml)) | [
"Defines",
"a",
"XML",
"body",
"value",
"to",
"match",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L410-L421 | [
"def",
"xml",
"(",
"self",
",",
"xml",
")",
":",
"self",
".",
"_request",
".",
"xml",
"=",
"xml",
"self",
".",
"add_matcher",
"(",
"matcher",
"(",
"'XMLMatcher'",
",",
"xml",
")",
")"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.file | Reads the body to match from a disk file.
Arguments:
path (str): relative or absolute path to file to read from.
Returns:
self: current Mock instance. | pook/mock.py | def file(self, path):
"""
Reads the body to match from a disk file.
Arguments:
path (str): relative or absolute path to file to read from.
Returns:
self: current Mock instance.
"""
with open(path, 'r') as f:
self.body(str(f.read())) | def file(self, path):
"""
Reads the body to match from a disk file.
Arguments:
path (str): relative or absolute path to file to read from.
Returns:
self: current Mock instance.
"""
with open(path, 'r') as f:
self.body(str(f.read())) | [
"Reads",
"the",
"body",
"to",
"match",
"from",
"a",
"disk",
"file",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L424-L435 | [
"def",
"file",
"(",
"self",
",",
"path",
")",
":",
"with",
"open",
"(",
"path",
",",
"'r'",
")",
"as",
"f",
":",
"self",
".",
"body",
"(",
"str",
"(",
"f",
".",
"read",
"(",
")",
")",
")"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.persist | Enables persistent mode for the current mock.
Returns:
self: current Mock instance. | pook/mock.py | def persist(self, status=None):
"""
Enables persistent mode for the current mock.
Returns:
self: current Mock instance.
"""
self._persist = status if type(status) is bool else True | def persist(self, status=None):
"""
Enables persistent mode for the current mock.
Returns:
self: current Mock instance.
"""
self._persist = status if type(status) is bool else True | [
"Enables",
"persistent",
"mode",
"for",
"the",
"current",
"mock",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L496-L503 | [
"def",
"persist",
"(",
"self",
",",
"status",
"=",
"None",
")",
":",
"self",
".",
"_persist",
"=",
"status",
"if",
"type",
"(",
"status",
")",
"is",
"bool",
"else",
"True"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.error | Defines a simulated exception error that will be raised.
Arguments:
error (str|Exception): error to raise.
Returns:
self: current Mock instance. | pook/mock.py | def error(self, error):
"""
Defines a simulated exception error that will be raised.
Arguments:
error (str|Exception): error to raise.
Returns:
self: current Mock instance.
"""
self._error = RuntimeError(error) if isinstance(error, str) else erro... | def error(self, error):
"""
Defines a simulated exception error that will be raised.
Arguments:
error (str|Exception): error to raise.
Returns:
self: current Mock instance.
"""
self._error = RuntimeError(error) if isinstance(error, str) else erro... | [
"Defines",
"a",
"simulated",
"exception",
"error",
"that",
"will",
"be",
"raised",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L562-L572 | [
"def",
"error",
"(",
"self",
",",
"error",
")",
":",
"self",
".",
"_error",
"=",
"RuntimeError",
"(",
"error",
")",
"if",
"isinstance",
"(",
"error",
",",
"str",
")",
"else",
"error"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.reply | Defines the mock response.
Arguments:
status (int, optional): response status code. Defaults to ``200``.
**kw (dict): optional keyword arguments passed to ``pook.Response``
constructor.
Returns:
pook.Response: mock response definition instance. | pook/mock.py | def reply(self, status=200, new_response=False, **kw):
"""
Defines the mock response.
Arguments:
status (int, optional): response status code. Defaults to ``200``.
**kw (dict): optional keyword arguments passed to ``pook.Response``
constructor.
R... | def reply(self, status=200, new_response=False, **kw):
"""
Defines the mock response.
Arguments:
status (int, optional): response status code. Defaults to ``200``.
**kw (dict): optional keyword arguments passed to ``pook.Response``
constructor.
R... | [
"Defines",
"the",
"mock",
"response",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L574-L595 | [
"def",
"reply",
"(",
"self",
",",
"status",
"=",
"200",
",",
"new_response",
"=",
"False",
",",
"*",
"*",
"kw",
")",
":",
"# Use or create a Response mock instance",
"res",
"=",
"Response",
"(",
"*",
"*",
"kw",
")",
"if",
"new_response",
"else",
"self",
... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Mock.match | Matches an outgoing HTTP request against the current mock matchers.
This method acts like a delegator to `pook.MatcherEngine`.
Arguments:
request (pook.Request): request instance to match.
Raises:
Exception: if the mock has an exception defined.
Returns:
... | pook/mock.py | def match(self, request):
"""
Matches an outgoing HTTP request against the current mock matchers.
This method acts like a delegator to `pook.MatcherEngine`.
Arguments:
request (pook.Request): request instance to match.
Raises:
Exception: if the mock has... | def match(self, request):
"""
Matches an outgoing HTTP request against the current mock matchers.
This method acts like a delegator to `pook.MatcherEngine`.
Arguments:
request (pook.Request): request instance to match.
Raises:
Exception: if the mock has... | [
"Matches",
"an",
"outgoing",
"HTTP",
"request",
"against",
"the",
"current",
"mock",
"matchers",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock.py#L697-L752 | [
"def",
"match",
"(",
"self",
",",
"request",
")",
":",
"# If mock already expired, fail it",
"if",
"self",
".",
"_times",
"<=",
"0",
":",
"raise",
"PookExpiredMock",
"(",
"'Mock expired'",
")",
"# Trigger mock filters",
"for",
"test",
"in",
"self",
".",
"filters... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | activate_async | Async version of activate decorator
Arguments:
fn (function): function that be wrapped by decorator.
_engine (Engine): pook engine instance
Returns:
function: decorator wrapper function. | pook/activate_async.py | def activate_async(fn, _engine):
"""
Async version of activate decorator
Arguments:
fn (function): function that be wrapped by decorator.
_engine (Engine): pook engine instance
Returns:
function: decorator wrapper function.
"""
@coroutine
@functools.wraps(fn)
de... | def activate_async(fn, _engine):
"""
Async version of activate decorator
Arguments:
fn (function): function that be wrapped by decorator.
_engine (Engine): pook engine instance
Returns:
function: decorator wrapper function.
"""
@coroutine
@functools.wraps(fn)
de... | [
"Async",
"version",
"of",
"activate",
"decorator"
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/activate_async.py#L5-L28 | [
"def",
"activate_async",
"(",
"fn",
",",
"_engine",
")",
":",
"@",
"coroutine",
"@",
"functools",
".",
"wraps",
"(",
"fn",
")",
"def",
"wrapper",
"(",
"*",
"args",
",",
"*",
"*",
"kw",
")",
":",
"_engine",
".",
"activate",
"(",
")",
"try",
":",
"... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Engine.set_mock_engine | Sets a custom mock engine, replacing the built-in one.
This is particularly useful if you want to replace the built-in
HTTP traffic mock interceptor engine with your custom one.
For mock engine implementation details, see `pook.MockEngine`.
Arguments:
engine (pook.MockEngi... | pook/engine.py | def set_mock_engine(self, engine):
"""
Sets a custom mock engine, replacing the built-in one.
This is particularly useful if you want to replace the built-in
HTTP traffic mock interceptor engine with your custom one.
For mock engine implementation details, see `pook.MockEngine`... | def set_mock_engine(self, engine):
"""
Sets a custom mock engine, replacing the built-in one.
This is particularly useful if you want to replace the built-in
HTTP traffic mock interceptor engine with your custom one.
For mock engine implementation details, see `pook.MockEngine`... | [
"Sets",
"a",
"custom",
"mock",
"engine",
"replacing",
"the",
"built",
"-",
"in",
"one",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/engine.py#L53-L82 | [
"def",
"set_mock_engine",
"(",
"self",
",",
"engine",
")",
":",
"if",
"not",
"engine",
":",
"raise",
"TypeError",
"(",
"'engine must be a valid object'",
")",
"# Instantiate mock engine",
"mock_engine",
"=",
"engine",
"(",
"self",
")",
"# Validate minimum viable inter... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Engine.enable_network | Enables real networking mode, optionally passing one or multiple
hostnames that would be used as filter.
If at least one hostname matches with the outgoing traffic, the
request will be executed via the real network.
Arguments:
*hostnames: optional list of host names to enab... | pook/engine.py | def enable_network(self, *hostnames):
"""
Enables real networking mode, optionally passing one or multiple
hostnames that would be used as filter.
If at least one hostname matches with the outgoing traffic, the
request will be executed via the real network.
Arguments:
... | def enable_network(self, *hostnames):
"""
Enables real networking mode, optionally passing one or multiple
hostnames that would be used as filter.
If at least one hostname matches with the outgoing traffic, the
request will be executed via the real network.
Arguments:
... | [
"Enables",
"real",
"networking",
"mode",
"optionally",
"passing",
"one",
"or",
"multiple",
"hostnames",
"that",
"would",
"be",
"used",
"as",
"filter",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/engine.py#L84-L104 | [
"def",
"enable_network",
"(",
"self",
",",
"*",
"hostnames",
")",
":",
"def",
"hostname_filter",
"(",
"hostname",
",",
"req",
")",
":",
"if",
"isregex",
"(",
"hostname",
")",
":",
"return",
"hostname",
".",
"match",
"(",
"req",
".",
"url",
".",
"hostna... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Engine.mock | Creates and registers a new HTTP mock in the current engine.
Arguments:
url (str): request URL to mock.
activate (bool): force mock engine activation.
Defaults to ``False``.
**kw (mixed): variadic keyword arguments for ``Mock`` constructor.
Returns:
... | pook/engine.py | def mock(self, url=None, **kw):
"""
Creates and registers a new HTTP mock in the current engine.
Arguments:
url (str): request URL to mock.
activate (bool): force mock engine activation.
Defaults to ``False``.
**kw (mixed): variadic keyword ar... | def mock(self, url=None, **kw):
"""
Creates and registers a new HTTP mock in the current engine.
Arguments:
url (str): request URL to mock.
activate (bool): force mock engine activation.
Defaults to ``False``.
**kw (mixed): variadic keyword ar... | [
"Creates",
"and",
"registers",
"a",
"new",
"HTTP",
"mock",
"in",
"the",
"current",
"engine",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/engine.py#L129-L155 | [
"def",
"mock",
"(",
"self",
",",
"url",
"=",
"None",
",",
"*",
"*",
"kw",
")",
":",
"# Activate mock engine, if explicitly requested",
"if",
"kw",
".",
"get",
"(",
"'activate'",
")",
":",
"kw",
".",
"pop",
"(",
"'activate'",
")",
"self",
".",
"activate",... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Engine.remove_mock | Removes a specific mock instance by object reference.
Arguments:
mock (pook.Mock): mock instance to remove. | pook/engine.py | def remove_mock(self, mock):
"""
Removes a specific mock instance by object reference.
Arguments:
mock (pook.Mock): mock instance to remove.
"""
self.mocks = [m for m in self.mocks if m is not mock] | def remove_mock(self, mock):
"""
Removes a specific mock instance by object reference.
Arguments:
mock (pook.Mock): mock instance to remove.
"""
self.mocks = [m for m in self.mocks if m is not mock] | [
"Removes",
"a",
"specific",
"mock",
"instance",
"by",
"object",
"reference",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/engine.py#L166-L173 | [
"def",
"remove_mock",
"(",
"self",
",",
"mock",
")",
":",
"self",
".",
"mocks",
"=",
"[",
"m",
"for",
"m",
"in",
"self",
".",
"mocks",
"if",
"m",
"is",
"not",
"mock",
"]"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Engine.activate | Activates the registered interceptors in the mocking engine.
This means any HTTP traffic captures by those interceptors will
trigger the HTTP mock matching engine in order to determine if a given
HTTP transaction should be mocked out or not. | pook/engine.py | def activate(self):
"""
Activates the registered interceptors in the mocking engine.
This means any HTTP traffic captures by those interceptors will
trigger the HTTP mock matching engine in order to determine if a given
HTTP transaction should be mocked out or not.
"""
... | def activate(self):
"""
Activates the registered interceptors in the mocking engine.
This means any HTTP traffic captures by those interceptors will
trigger the HTTP mock matching engine in order to determine if a given
HTTP transaction should be mocked out or not.
"""
... | [
"Activates",
"the",
"registered",
"interceptors",
"in",
"the",
"mocking",
"engine",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/engine.py#L232-L246 | [
"def",
"activate",
"(",
"self",
")",
":",
"if",
"self",
".",
"active",
":",
"return",
"None",
"# Activate mock engine",
"self",
".",
"mock_engine",
".",
"activate",
"(",
")",
"# Enable engine state",
"self",
".",
"active",
"=",
"True"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Engine.disable | Disables interceptors and stops intercepting any outgoing HTTP traffic. | pook/engine.py | def disable(self):
"""
Disables interceptors and stops intercepting any outgoing HTTP traffic.
"""
if not self.active:
return None
# Disable current mock engine
self.mock_engine.disable()
# Disable engine state
self.active = False | def disable(self):
"""
Disables interceptors and stops intercepting any outgoing HTTP traffic.
"""
if not self.active:
return None
# Disable current mock engine
self.mock_engine.disable()
# Disable engine state
self.active = False | [
"Disables",
"interceptors",
"and",
"stops",
"intercepting",
"any",
"outgoing",
"HTTP",
"traffic",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/engine.py#L248-L258 | [
"def",
"disable",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"active",
":",
"return",
"None",
"# Disable current mock engine",
"self",
".",
"mock_engine",
".",
"disable",
"(",
")",
"# Disable engine state",
"self",
".",
"active",
"=",
"False"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Engine.should_use_network | Verifies if real networking mode should be used for the given
request, passing it to the registered network filters.
Arguments:
request (pook.Request): outgoing HTTP request to test.
Returns:
bool | pook/engine.py | def should_use_network(self, request):
"""
Verifies if real networking mode should be used for the given
request, passing it to the registered network filters.
Arguments:
request (pook.Request): outgoing HTTP request to test.
Returns:
bool
"""
... | def should_use_network(self, request):
"""
Verifies if real networking mode should be used for the given
request, passing it to the registered network filters.
Arguments:
request (pook.Request): outgoing HTTP request to test.
Returns:
bool
"""
... | [
"Verifies",
"if",
"real",
"networking",
"mode",
"should",
"be",
"used",
"for",
"the",
"given",
"request",
"passing",
"it",
"to",
"the",
"registered",
"network",
"filters",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/engine.py#L370-L382 | [
"def",
"should_use_network",
"(",
"self",
",",
"request",
")",
":",
"return",
"(",
"self",
".",
"networking",
"and",
"all",
"(",
"(",
"fn",
"(",
"request",
")",
"for",
"fn",
"in",
"self",
".",
"network_filters",
")",
")",
")"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Engine.match | Matches a given Request instance contract against the registered mocks.
If a mock passes all the matchers, its response will be returned.
Arguments:
request (pook.Request): Request contract to match.
Raises:
pook.PookNoMatches: if networking is disabled and no mock mat... | pook/engine.py | def match(self, request):
"""
Matches a given Request instance contract against the registered mocks.
If a mock passes all the matchers, its response will be returned.
Arguments:
request (pook.Request): Request contract to match.
Raises:
pook.PookNoMatc... | def match(self, request):
"""
Matches a given Request instance contract against the registered mocks.
If a mock passes all the matchers, its response will be returned.
Arguments:
request (pook.Request): Request contract to match.
Raises:
pook.PookNoMatc... | [
"Matches",
"a",
"given",
"Request",
"instance",
"contract",
"against",
"the",
"registered",
"mocks",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/engine.py#L384-L446 | [
"def",
"match",
"(",
"self",
",",
"request",
")",
":",
"# Trigger engine-level request filters",
"for",
"test",
"in",
"self",
".",
"filters",
":",
"if",
"not",
"test",
"(",
"request",
",",
"self",
")",
":",
"return",
"False",
"# Trigger engine-level request mapp... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | Request.copy | Copies the current Request object instance for side-effects purposes.
Returns:
pook.Request: copy of the current Request instance. | pook/request.py | def copy(self):
"""
Copies the current Request object instance for side-effects purposes.
Returns:
pook.Request: copy of the current Request instance.
"""
req = type(self)()
req.__dict__ = self.__dict__.copy()
req._headers = self.headers.copy()
... | def copy(self):
"""
Copies the current Request object instance for side-effects purposes.
Returns:
pook.Request: copy of the current Request instance.
"""
req = type(self)()
req.__dict__ = self.__dict__.copy()
req._headers = self.headers.copy()
... | [
"Copies",
"the",
"current",
"Request",
"object",
"instance",
"for",
"side",
"-",
"effects",
"purposes",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/request.py#L141-L151 | [
"def",
"copy",
"(",
"self",
")",
":",
"req",
"=",
"type",
"(",
"self",
")",
"(",
")",
"req",
".",
"__dict__",
"=",
"self",
".",
"__dict__",
".",
"copy",
"(",
")",
"req",
".",
"_headers",
"=",
"self",
".",
"headers",
".",
"copy",
"(",
")",
"retu... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | activate | Enables the HTTP traffic interceptors.
This function can be used as decorator.
Arguments:
fn (function|coroutinefunction): Optional function argument
if used as decorator.
Returns:
function: decorator wrapper function, only if called as decorator,
otherwise ``None`... | pook/api.py | def activate(fn=None):
"""
Enables the HTTP traffic interceptors.
This function can be used as decorator.
Arguments:
fn (function|coroutinefunction): Optional function argument
if used as decorator.
Returns:
function: decorator wrapper function, only if called as decor... | def activate(fn=None):
"""
Enables the HTTP traffic interceptors.
This function can be used as decorator.
Arguments:
fn (function|coroutinefunction): Optional function argument
if used as decorator.
Returns:
function: decorator wrapper function, only if called as decor... | [
"Enables",
"the",
"HTTP",
"traffic",
"interceptors",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/api.py#L73-L122 | [
"def",
"activate",
"(",
"fn",
"=",
"None",
")",
":",
"# If not used as decorator, activate the engine and exit",
"if",
"not",
"isfunction",
"(",
"fn",
")",
":",
"_engine",
".",
"activate",
"(",
")",
"return",
"None",
"# If used as decorator for an async coroutine, wrap ... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | use | Creates a new isolated mock engine to be used via context manager.
Example::
with pook.use() as engine:
pook.mock('server.com/foo').reply(404)
res = requests.get('server.com/foo')
assert res.status_code == 404 | pook/api.py | def use(network=False):
"""
Creates a new isolated mock engine to be used via context manager.
Example::
with pook.use() as engine:
pook.mock('server.com/foo').reply(404)
res = requests.get('server.com/foo')
assert res.status_code == 404
"""
global _eng... | def use(network=False):
"""
Creates a new isolated mock engine to be used via context manager.
Example::
with pook.use() as engine:
pook.mock('server.com/foo').reply(404)
res = requests.get('server.com/foo')
assert res.status_code == 404
"""
global _eng... | [
"Creates",
"a",
"new",
"isolated",
"mock",
"engine",
"to",
"be",
"used",
"via",
"context",
"manager",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/api.py#L185-L219 | [
"def",
"use",
"(",
"network",
"=",
"False",
")",
":",
"global",
"_engine",
"# Create temporal engine",
"__engine",
"=",
"_engine",
"activated",
"=",
"__engine",
".",
"active",
"if",
"activated",
":",
"__engine",
".",
"disable",
"(",
")",
"_engine",
"=",
"Eng... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | regex | Convenient shortcut to ``re.compile()`` for fast, easy to use
regular expression compilation without an extra import statement.
Arguments:
expression (str): regular expression value.
flags (int): optional regular expression flags.
Defaults to ``re.IGNORECASE``
Returns:
... | pook/api.py | def regex(expression, flags=re.IGNORECASE):
"""
Convenient shortcut to ``re.compile()`` for fast, easy to use
regular expression compilation without an extra import statement.
Arguments:
expression (str): regular expression value.
flags (int): optional regular expression flags.
... | def regex(expression, flags=re.IGNORECASE):
"""
Convenient shortcut to ``re.compile()`` for fast, easy to use
regular expression compilation without an extra import statement.
Arguments:
expression (str): regular expression value.
flags (int): optional regular expression flags.
... | [
"Convenient",
"shortcut",
"to",
"re",
".",
"compile",
"()",
"for",
"fast",
"easy",
"to",
"use",
"regular",
"expression",
"compilation",
"without",
"an",
"extra",
"import",
"statement",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/api.py#L510-L532 | [
"def",
"regex",
"(",
"expression",
",",
"flags",
"=",
"re",
".",
"IGNORECASE",
")",
":",
"return",
"re",
".",
"compile",
"(",
"expression",
",",
"flags",
"=",
"flags",
")"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | MockEngine.add_interceptor | Adds one or multiple HTTP traffic interceptors to the current
mocking engine.
Interceptors are typically HTTP client specific wrapper classes that
implements the pook interceptor interface.
Arguments:
interceptors (pook.interceptors.BaseInterceptor) | pook/mock_engine.py | def add_interceptor(self, *interceptors):
"""
Adds one or multiple HTTP traffic interceptors to the current
mocking engine.
Interceptors are typically HTTP client specific wrapper classes that
implements the pook interceptor interface.
Arguments:
interceptor... | def add_interceptor(self, *interceptors):
"""
Adds one or multiple HTTP traffic interceptors to the current
mocking engine.
Interceptors are typically HTTP client specific wrapper classes that
implements the pook interceptor interface.
Arguments:
interceptor... | [
"Adds",
"one",
"or",
"multiple",
"HTTP",
"traffic",
"interceptors",
"to",
"the",
"current",
"mocking",
"engine",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock_engine.py#L49-L61 | [
"def",
"add_interceptor",
"(",
"self",
",",
"*",
"interceptors",
")",
":",
"for",
"interceptor",
"in",
"interceptors",
":",
"self",
".",
"interceptors",
".",
"append",
"(",
"interceptor",
"(",
"self",
".",
"engine",
")",
")"
] | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | MockEngine.remove_interceptor | Removes a specific interceptor by name.
Arguments:
name (str): interceptor name to disable.
Returns:
bool: `True` if the interceptor was disabled, otherwise `False`. | pook/mock_engine.py | def remove_interceptor(self, name):
"""
Removes a specific interceptor by name.
Arguments:
name (str): interceptor name to disable.
Returns:
bool: `True` if the interceptor was disabled, otherwise `False`.
"""
for index, interceptor in enumerate(... | def remove_interceptor(self, name):
"""
Removes a specific interceptor by name.
Arguments:
name (str): interceptor name to disable.
Returns:
bool: `True` if the interceptor was disabled, otherwise `False`.
"""
for index, interceptor in enumerate(... | [
"Removes",
"a",
"specific",
"interceptor",
"by",
"name",
"."
] | h2non/pook | python | https://github.com/h2non/pook/blob/e64094e41e4d89d98d2d29af7608ef27dc50cf19/pook/mock_engine.py#L71-L89 | [
"def",
"remove_interceptor",
"(",
"self",
",",
"name",
")",
":",
"for",
"index",
",",
"interceptor",
"in",
"enumerate",
"(",
"self",
".",
"interceptors",
")",
":",
"matches",
"=",
"(",
"type",
"(",
"interceptor",
")",
".",
"__name__",
"==",
"name",
"or",... | e64094e41e4d89d98d2d29af7608ef27dc50cf19 |
test | get_setting | Get key from connection or default to settings. | pgcrypto/mixins.py | def get_setting(connection, key):
"""Get key from connection or default to settings."""
if key in connection.settings_dict:
return connection.settings_dict[key]
else:
return getattr(settings, key) | def get_setting(connection, key):
"""Get key from connection or default to settings."""
if key in connection.settings_dict:
return connection.settings_dict[key]
else:
return getattr(settings, key) | [
"Get",
"key",
"from",
"connection",
"or",
"default",
"to",
"settings",
"."
] | incuna/django-pgcrypto-fields | python | https://github.com/incuna/django-pgcrypto-fields/blob/406fddf0cbe9091ba71b97206d0f4719c0450ac1/pgcrypto/mixins.py#L13-L18 | [
"def",
"get_setting",
"(",
"connection",
",",
"key",
")",
":",
"if",
"key",
"in",
"connection",
".",
"settings_dict",
":",
"return",
"connection",
".",
"settings_dict",
"[",
"key",
"]",
"else",
":",
"return",
"getattr",
"(",
"settings",
",",
"key",
")"
] | 406fddf0cbe9091ba71b97206d0f4719c0450ac1 |
test | DecryptedCol.as_sql | Build SQL with decryption and casting. | pgcrypto/mixins.py | def as_sql(self, compiler, connection):
"""Build SQL with decryption and casting."""
sql, params = super(DecryptedCol, self).as_sql(compiler, connection)
sql = self.target.get_decrypt_sql(connection) % (sql, self.target.get_cast_sql())
return sql, params | def as_sql(self, compiler, connection):
"""Build SQL with decryption and casting."""
sql, params = super(DecryptedCol, self).as_sql(compiler, connection)
sql = self.target.get_decrypt_sql(connection) % (sql, self.target.get_cast_sql())
return sql, params | [
"Build",
"SQL",
"with",
"decryption",
"and",
"casting",
"."
] | incuna/django-pgcrypto-fields | python | https://github.com/incuna/django-pgcrypto-fields/blob/406fddf0cbe9091ba71b97206d0f4719c0450ac1/pgcrypto/mixins.py#L30-L34 | [
"def",
"as_sql",
"(",
"self",
",",
"compiler",
",",
"connection",
")",
":",
"sql",
",",
"params",
"=",
"super",
"(",
"DecryptedCol",
",",
"self",
")",
".",
"as_sql",
"(",
"compiler",
",",
"connection",
")",
"sql",
"=",
"self",
".",
"target",
".",
"ge... | 406fddf0cbe9091ba71b97206d0f4719c0450ac1 |
test | HashMixin.pre_save | Save the original_value. | pgcrypto/mixins.py | def pre_save(self, model_instance, add):
"""Save the original_value."""
if self.original:
original_value = getattr(model_instance, self.original)
setattr(model_instance, self.attname, original_value)
return super(HashMixin, self).pre_save(model_instance, add) | def pre_save(self, model_instance, add):
"""Save the original_value."""
if self.original:
original_value = getattr(model_instance, self.original)
setattr(model_instance, self.attname, original_value)
return super(HashMixin, self).pre_save(model_instance, add) | [
"Save",
"the",
"original_value",
"."
] | incuna/django-pgcrypto-fields | python | https://github.com/incuna/django-pgcrypto-fields/blob/406fddf0cbe9091ba71b97206d0f4719c0450ac1/pgcrypto/mixins.py#L50-L56 | [
"def",
"pre_save",
"(",
"self",
",",
"model_instance",
",",
"add",
")",
":",
"if",
"self",
".",
"original",
":",
"original_value",
"=",
"getattr",
"(",
"model_instance",
",",
"self",
".",
"original",
")",
"setattr",
"(",
"model_instance",
",",
"self",
".",... | 406fddf0cbe9091ba71b97206d0f4719c0450ac1 |
test | HashMixin.get_placeholder | Tell postgres to encrypt this field with a hashing function.
The `value` string is checked to determine if we need to hash or keep
the current value.
`compiler` and `connection` is ignored here as we don't need custom operators. | pgcrypto/mixins.py | def get_placeholder(self, value=None, compiler=None, connection=None):
"""
Tell postgres to encrypt this field with a hashing function.
The `value` string is checked to determine if we need to hash or keep
the current value.
`compiler` and `connection` is ignored here as we don... | def get_placeholder(self, value=None, compiler=None, connection=None):
"""
Tell postgres to encrypt this field with a hashing function.
The `value` string is checked to determine if we need to hash or keep
the current value.
`compiler` and `connection` is ignored here as we don... | [
"Tell",
"postgres",
"to",
"encrypt",
"this",
"field",
"with",
"a",
"hashing",
"function",
"."
] | incuna/django-pgcrypto-fields | python | https://github.com/incuna/django-pgcrypto-fields/blob/406fddf0cbe9091ba71b97206d0f4719c0450ac1/pgcrypto/mixins.py#L58-L70 | [
"def",
"get_placeholder",
"(",
"self",
",",
"value",
"=",
"None",
",",
"compiler",
"=",
"None",
",",
"connection",
"=",
"None",
")",
":",
"if",
"value",
"is",
"None",
"or",
"value",
".",
"startswith",
"(",
"'\\\\x'",
")",
":",
"return",
"'%s'",
"return... | 406fddf0cbe9091ba71b97206d0f4719c0450ac1 |
test | PGPMixin.get_col | Get the decryption for col. | pgcrypto/mixins.py | def get_col(self, alias, output_field=None):
"""Get the decryption for col."""
if output_field is None:
output_field = self
if alias != self.model._meta.db_table or output_field != self:
return DecryptedCol(
alias,
self,
out... | def get_col(self, alias, output_field=None):
"""Get the decryption for col."""
if output_field is None:
output_field = self
if alias != self.model._meta.db_table or output_field != self:
return DecryptedCol(
alias,
self,
out... | [
"Get",
"the",
"decryption",
"for",
"col",
"."
] | incuna/django-pgcrypto-fields | python | https://github.com/incuna/django-pgcrypto-fields/blob/406fddf0cbe9091ba71b97206d0f4719c0450ac1/pgcrypto/mixins.py#L106-L117 | [
"def",
"get_col",
"(",
"self",
",",
"alias",
",",
"output_field",
"=",
"None",
")",
":",
"if",
"output_field",
"is",
"None",
":",
"output_field",
"=",
"self",
"if",
"alias",
"!=",
"self",
".",
"model",
".",
"_meta",
".",
"db_table",
"or",
"output_field",... | 406fddf0cbe9091ba71b97206d0f4719c0450ac1 |
test | PGPPublicKeyFieldMixin.get_placeholder | Tell postgres to encrypt this field using PGP. | pgcrypto/mixins.py | def get_placeholder(self, value=None, compiler=None, connection=None):
"""Tell postgres to encrypt this field using PGP."""
return self.encrypt_sql.format(get_setting(connection, 'PUBLIC_PGP_KEY')) | def get_placeholder(self, value=None, compiler=None, connection=None):
"""Tell postgres to encrypt this field using PGP."""
return self.encrypt_sql.format(get_setting(connection, 'PUBLIC_PGP_KEY')) | [
"Tell",
"postgres",
"to",
"encrypt",
"this",
"field",
"using",
"PGP",
"."
] | incuna/django-pgcrypto-fields | python | https://github.com/incuna/django-pgcrypto-fields/blob/406fddf0cbe9091ba71b97206d0f4719c0450ac1/pgcrypto/mixins.py#L134-L136 | [
"def",
"get_placeholder",
"(",
"self",
",",
"value",
"=",
"None",
",",
"compiler",
"=",
"None",
",",
"connection",
"=",
"None",
")",
":",
"return",
"self",
".",
"encrypt_sql",
".",
"format",
"(",
"get_setting",
"(",
"connection",
",",
"'PUBLIC_PGP_KEY'",
"... | 406fddf0cbe9091ba71b97206d0f4719c0450ac1 |
test | hunt_repeated_yaml_keys | Parses yaml and returns a list of repeated variables and
the line on which they occur | lib/ansiblereview/vars.py | def hunt_repeated_yaml_keys(data):
"""Parses yaml and returns a list of repeated variables and
the line on which they occur
"""
loader = yaml.Loader(data)
def compose_node(parent, index):
# the line number where the previous token has ended (plus empty lines)
line = loader.line
... | def hunt_repeated_yaml_keys(data):
"""Parses yaml and returns a list of repeated variables and
the line on which they occur
"""
loader = yaml.Loader(data)
def compose_node(parent, index):
# the line number where the previous token has ended (plus empty lines)
line = loader.line
... | [
"Parses",
"yaml",
"and",
"returns",
"a",
"list",
"of",
"repeated",
"variables",
"and",
"the",
"line",
"on",
"which",
"they",
"occur"
] | willthames/ansible-review | python | https://github.com/willthames/ansible-review/blob/c55c8f1d1c009f48c289160a28188ff2f3152486/lib/ansiblereview/vars.py#L7-L38 | [
"def",
"hunt_repeated_yaml_keys",
"(",
"data",
")",
":",
"loader",
"=",
"yaml",
".",
"Loader",
"(",
"data",
")",
"def",
"compose_node",
"(",
"parent",
",",
"index",
")",
":",
"# the line number where the previous token has ended (plus empty lines)",
"line",
"=",
"lo... | c55c8f1d1c009f48c289160a28188ff2f3152486 |
test | base_regression | this function calculates the regression coefficients for a
given vector containing the averages of tip and branch
quantities.
Parameters
----------
Q : numpy.array
vector with
slope : None, optional
Description
Returns
-------
TYPE
Description | treetime/treeregression.py | def base_regression(Q, slope=None):
"""
this function calculates the regression coefficients for a
given vector containing the averages of tip and branch
quantities.
Parameters
----------
Q : numpy.array
vector with
slope : None, optional
Description
Returns
---... | def base_regression(Q, slope=None):
"""
this function calculates the regression coefficients for a
given vector containing the averages of tip and branch
quantities.
Parameters
----------
Q : numpy.array
vector with
slope : None, optional
Description
Returns
---... | [
"this",
"function",
"calculates",
"the",
"regression",
"coefficients",
"for",
"a",
"given",
"vector",
"containing",
"the",
"averages",
"of",
"tip",
"and",
"branch",
"quantities",
"."
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/treeregression.py#L6-L45 | [
"def",
"base_regression",
"(",
"Q",
",",
"slope",
"=",
"None",
")",
":",
"if",
"slope",
"is",
"None",
":",
"slope",
"=",
"(",
"Q",
"[",
"dtavgii",
"]",
"-",
"Q",
"[",
"tavgii",
"]",
"*",
"Q",
"[",
"davgii",
"]",
"/",
"Q",
"[",
"sii",
"]",
")"... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | TreeRegression.Cov | calculate the covariance matrix of the tips assuming variance
has accumulated along branches of the tree accoriding to the
the provided
Returns
-------
M : (np.array)
covariance matrix with tips arranged standard transersal order. | treetime/treeregression.py | def Cov(self):
"""
calculate the covariance matrix of the tips assuming variance
has accumulated along branches of the tree accoriding to the
the provided
Returns
-------
M : (np.array)
covariance matrix with tips arranged standard transersal order.
... | def Cov(self):
"""
calculate the covariance matrix of the tips assuming variance
has accumulated along branches of the tree accoriding to the
the provided
Returns
-------
M : (np.array)
covariance matrix with tips arranged standard transersal order.
... | [
"calculate",
"the",
"covariance",
"matrix",
"of",
"the",
"tips",
"assuming",
"variance",
"has",
"accumulated",
"along",
"branches",
"of",
"the",
"tree",
"accoriding",
"to",
"the",
"the",
"provided",
"Returns",
"-------"
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/treeregression.py#L113-L130 | [
"def",
"Cov",
"(",
"self",
")",
":",
"# accumulate the covariance matrix by adding 'squares'",
"M",
"=",
"np",
".",
"zeros",
"(",
"(",
"self",
".",
"N",
",",
"self",
".",
"N",
")",
")",
"for",
"n",
"in",
"self",
".",
"tree",
".",
"find_clades",
"(",
")... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | TreeRegression.CovInv | Inverse of the covariance matrix
Returns
-------
H : (np.array)
inverse of the covariance matrix. | treetime/treeregression.py | def CovInv(self):
"""
Inverse of the covariance matrix
Returns
-------
H : (np.array)
inverse of the covariance matrix.
"""
self.recurse(full_matrix=True)
return self.tree.root.cinv | def CovInv(self):
"""
Inverse of the covariance matrix
Returns
-------
H : (np.array)
inverse of the covariance matrix.
"""
self.recurse(full_matrix=True)
return self.tree.root.cinv | [
"Inverse",
"of",
"the",
"covariance",
"matrix"
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/treeregression.py#L133-L144 | [
"def",
"CovInv",
"(",
"self",
")",
":",
"self",
".",
"recurse",
"(",
"full_matrix",
"=",
"True",
")",
"return",
"self",
".",
"tree",
".",
"root",
".",
"cinv"
] | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | TreeRegression.recurse | recursion to calculate inverse covariance matrix
Parameters
----------
full_matrix : bool, optional
if True, the entire inverse matrix is calculated. otherwise, only the weighing vector. | treetime/treeregression.py | def recurse(self, full_matrix=False):
"""
recursion to calculate inverse covariance matrix
Parameters
----------
full_matrix : bool, optional
if True, the entire inverse matrix is calculated. otherwise, only the weighing vector.
"""
for n in self.tree... | def recurse(self, full_matrix=False):
"""
recursion to calculate inverse covariance matrix
Parameters
----------
full_matrix : bool, optional
if True, the entire inverse matrix is calculated. otherwise, only the weighing vector.
"""
for n in self.tree... | [
"recursion",
"to",
"calculate",
"inverse",
"covariance",
"matrix"
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/treeregression.py#L147-L176 | [
"def",
"recurse",
"(",
"self",
",",
"full_matrix",
"=",
"False",
")",
":",
"for",
"n",
"in",
"self",
".",
"tree",
".",
"get_nonterminals",
"(",
"order",
"=",
"'postorder'",
")",
":",
"n_leaves",
"=",
"len",
"(",
"n",
".",
"_ii",
")",
"if",
"full_matr... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | TreeRegression._calculate_averages | calculate the weighted sums of the tip and branch values and
their second moments. | treetime/treeregression.py | def _calculate_averages(self):
"""
calculate the weighted sums of the tip and branch values and
their second moments.
"""
for n in self.tree.get_nonterminals(order='postorder'):
Q = np.zeros(6, dtype=float)
for c in n:
tv = self.tip_value(c... | def _calculate_averages(self):
"""
calculate the weighted sums of the tip and branch values and
their second moments.
"""
for n in self.tree.get_nonterminals(order='postorder'):
Q = np.zeros(6, dtype=float)
for c in n:
tv = self.tip_value(c... | [
"calculate",
"the",
"weighted",
"sums",
"of",
"the",
"tip",
"and",
"branch",
"values",
"and",
"their",
"second",
"moments",
"."
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/treeregression.py#L179-L220 | [
"def",
"_calculate_averages",
"(",
"self",
")",
":",
"for",
"n",
"in",
"self",
".",
"tree",
".",
"get_nonterminals",
"(",
"order",
"=",
"'postorder'",
")",
":",
"Q",
"=",
"np",
".",
"zeros",
"(",
"6",
",",
"dtype",
"=",
"float",
")",
"for",
"c",
"i... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | TreeRegression.propagate_averages | This function implements the propagation of the means,
variance, and covariances along a branch. It operates
both towards the root and tips.
Parameters
----------
n : (node)
the branch connecting this node to its parent is used
for propagation
t... | treetime/treeregression.py | def propagate_averages(self, n, tv, bv, var, outgroup=False):
"""
This function implements the propagation of the means,
variance, and covariances along a branch. It operates
both towards the root and tips.
Parameters
----------
n : (node)
the branch... | def propagate_averages(self, n, tv, bv, var, outgroup=False):
"""
This function implements the propagation of the means,
variance, and covariances along a branch. It operates
both towards the root and tips.
Parameters
----------
n : (node)
the branch... | [
"This",
"function",
"implements",
"the",
"propagation",
"of",
"the",
"means",
"variance",
"and",
"covariances",
"along",
"a",
"branch",
".",
"It",
"operates",
"both",
"towards",
"the",
"root",
"and",
"tips",
"."
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/treeregression.py#L223-L272 | [
"def",
"propagate_averages",
"(",
"self",
",",
"n",
",",
"tv",
",",
"bv",
",",
"var",
",",
"outgroup",
"=",
"False",
")",
":",
"if",
"n",
".",
"is_terminal",
"(",
")",
"and",
"outgroup",
"==",
"False",
":",
"if",
"tv",
"is",
"None",
"or",
"np",
"... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | TreeRegression.explained_variance | calculate standard explained variance
Returns
-------
float
r-value of the root-to-tip distance and time.
independent of regression model, but dependent on root choice | treetime/treeregression.py | def explained_variance(self):
"""calculate standard explained variance
Returns
-------
float
r-value of the root-to-tip distance and time.
independent of regression model, but dependent on root choice
"""
self.tree.root._v=0
for n in self.... | def explained_variance(self):
"""calculate standard explained variance
Returns
-------
float
r-value of the root-to-tip distance and time.
independent of regression model, but dependent on root choice
"""
self.tree.root._v=0
for n in self.... | [
"calculate",
"standard",
"explained",
"variance"
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/treeregression.py#L274-L289 | [
"def",
"explained_variance",
"(",
"self",
")",
":",
"self",
".",
"tree",
".",
"root",
".",
"_v",
"=",
"0",
"for",
"n",
"in",
"self",
".",
"tree",
".",
"get_nonterminals",
"(",
"order",
"=",
"'preorder'",
")",
":",
"for",
"c",
"in",
"n",
":",
"c",
... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | TreeRegression.regression | regress tip values against branch values
Parameters
----------
slope : None, optional
if given, the slope isn't optimized
Returns
-------
dict
regression parameters | treetime/treeregression.py | def regression(self, slope=None):
"""regress tip values against branch values
Parameters
----------
slope : None, optional
if given, the slope isn't optimized
Returns
-------
dict
regression parameters
"""
self._calculate_... | def regression(self, slope=None):
"""regress tip values against branch values
Parameters
----------
slope : None, optional
if given, the slope isn't optimized
Returns
-------
dict
regression parameters
"""
self._calculate_... | [
"regress",
"tip",
"values",
"against",
"branch",
"values"
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/treeregression.py#L292-L310 | [
"def",
"regression",
"(",
"self",
",",
"slope",
"=",
"None",
")",
":",
"self",
".",
"_calculate_averages",
"(",
")",
"clock_model",
"=",
"base_regression",
"(",
"self",
".",
"tree",
".",
"root",
".",
"Q",
",",
"slope",
")",
"clock_model",
"[",
"'r_val'",... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | TreeRegression.find_best_root | determine the position on the tree that minimizes the bilinear
product of the inverse covariance and the data vectors.
Returns
-------
best_root : (dict)
dictionary with the node, the fraction `x` at which the branch
is to be split, and the regression parameters | treetime/treeregression.py | def find_best_root(self, force_positive=True, slope=None):
"""
determine the position on the tree that minimizes the bilinear
product of the inverse covariance and the data vectors.
Returns
-------
best_root : (dict)
dictionary with the node, the fraction `x... | def find_best_root(self, force_positive=True, slope=None):
"""
determine the position on the tree that minimizes the bilinear
product of the inverse covariance and the data vectors.
Returns
-------
best_root : (dict)
dictionary with the node, the fraction `x... | [
"determine",
"the",
"position",
"on",
"the",
"tree",
"that",
"minimizes",
"the",
"bilinear",
"product",
"of",
"the",
"inverse",
"covariance",
"and",
"the",
"data",
"vectors",
"."
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/treeregression.py#L314-L372 | [
"def",
"find_best_root",
"(",
"self",
",",
"force_positive",
"=",
"True",
",",
"slope",
"=",
"None",
")",
":",
"self",
".",
"_calculate_averages",
"(",
")",
"best_root",
"=",
"{",
"\"chisq\"",
":",
"np",
".",
"inf",
"}",
"for",
"n",
"in",
"self",
".",
... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | TreeRegression.optimal_reroot | determine the best root and reroot the tree to this value.
Note that this can change the parent child relations of the tree
and values associated with branches rather than nodes
(e.g. confidence) might need to be re-evaluated afterwards
Parameters
----------
force_positi... | treetime/treeregression.py | def optimal_reroot(self, force_positive=True, slope=None):
"""
determine the best root and reroot the tree to this value.
Note that this can change the parent child relations of the tree
and values associated with branches rather than nodes
(e.g. confidence) might need to be re-e... | def optimal_reroot(self, force_positive=True, slope=None):
"""
determine the best root and reroot the tree to this value.
Note that this can change the parent child relations of the tree
and values associated with branches rather than nodes
(e.g. confidence) might need to be re-e... | [
"determine",
"the",
"best",
"root",
"and",
"reroot",
"the",
"tree",
"to",
"this",
"value",
".",
"Note",
"that",
"this",
"can",
"change",
"the",
"parent",
"child",
"relations",
"of",
"the",
"tree",
"and",
"values",
"associated",
"with",
"branches",
"rather",
... | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/treeregression.py#L402-L454 | [
"def",
"optimal_reroot",
"(",
"self",
",",
"force_positive",
"=",
"True",
",",
"slope",
"=",
"None",
")",
":",
"best_root",
"=",
"self",
".",
"find_best_root",
"(",
"force_positive",
"=",
"force_positive",
",",
"slope",
"=",
"slope",
")",
"best_node",
"=",
... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | TreeRegression.clock_plot | Plot root-to-tip distance vs time as a basic time-tree diagnostic
Parameters
----------
add_internal : bool, optional
add internal nodes. this will only work if the tree has been dated already
ax : None, optional
an matplotlib axis to plot into. if non provided, ... | treetime/treeregression.py | def clock_plot(self, add_internal=False, ax=None, regression=None,
confidence=True, n_sigma = 2, fs=14):
"""Plot root-to-tip distance vs time as a basic time-tree diagnostic
Parameters
----------
add_internal : bool, optional
add internal nodes. this will ... | def clock_plot(self, add_internal=False, ax=None, regression=None,
confidence=True, n_sigma = 2, fs=14):
"""Plot root-to-tip distance vs time as a basic time-tree diagnostic
Parameters
----------
add_internal : bool, optional
add internal nodes. this will ... | [
"Plot",
"root",
"-",
"to",
"-",
"tip",
"distance",
"vs",
"time",
"as",
"a",
"basic",
"time",
"-",
"tree",
"diagnostic"
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/treeregression.py#L457-L550 | [
"def",
"clock_plot",
"(",
"self",
",",
"add_internal",
"=",
"False",
",",
"ax",
"=",
"None",
",",
"regression",
"=",
"None",
",",
"confidence",
"=",
"True",
",",
"n_sigma",
"=",
"2",
",",
"fs",
"=",
"14",
")",
":",
"import",
"matplotlib",
".",
"pyplo... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | JC69 | Jukes-Cantor 1969 model. This model assumes equal concentrations
of the nucleotides and equal transition rates between nucleotide states.
For more info, see: Jukes and Cantor (1969). Evolution of Protein Molecules.
New York: Academic Press. pp. 21–132
Parameters
-----------
... | treetime/nuc_models.py | def JC69 (mu=1.0, alphabet="nuc", **kwargs):
"""
Jukes-Cantor 1969 model. This model assumes equal concentrations
of the nucleotides and equal transition rates between nucleotide states.
For more info, see: Jukes and Cantor (1969). Evolution of Protein Molecules.
New York: Academ... | def JC69 (mu=1.0, alphabet="nuc", **kwargs):
"""
Jukes-Cantor 1969 model. This model assumes equal concentrations
of the nucleotides and equal transition rates between nucleotide states.
For more info, see: Jukes and Cantor (1969). Evolution of Protein Molecules.
New York: Academ... | [
"Jukes",
"-",
"Cantor",
"1969",
"model",
".",
"This",
"model",
"assumes",
"equal",
"concentrations",
"of",
"the",
"nucleotides",
"and",
"equal",
"transition",
"rates",
"between",
"nucleotide",
"states",
".",
"For",
"more",
"info",
"see",
":",
"Jukes",
"and",
... | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/nuc_models.py#L8-L34 | [
"def",
"JC69",
"(",
"mu",
"=",
"1.0",
",",
"alphabet",
"=",
"\"nuc\"",
",",
"*",
"*",
"kwargs",
")",
":",
"num_chars",
"=",
"len",
"(",
"alphabets",
"[",
"alphabet",
"]",
")",
"W",
",",
"pi",
"=",
"np",
".",
"ones",
"(",
"(",
"num_chars",
",",
... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | K80 | Kimura 1980 model. Assumes equal concentrations across nucleotides, but
allows different rates between transitions and transversions. The ratio
of the transversion/transition rates is given by kappa parameter.
For more info, see
Kimura (1980), J. Mol. Evol. 16 (2): 111–120. doi:10.1007/BF01731581.
... | treetime/nuc_models.py | def K80(mu=1., kappa=0.1, **kwargs):
"""
Kimura 1980 model. Assumes equal concentrations across nucleotides, but
allows different rates between transitions and transversions. The ratio
of the transversion/transition rates is given by kappa parameter.
For more info, see
Kimura (1980), J. Mol. Ev... | def K80(mu=1., kappa=0.1, **kwargs):
"""
Kimura 1980 model. Assumes equal concentrations across nucleotides, but
allows different rates between transitions and transversions. The ratio
of the transversion/transition rates is given by kappa parameter.
For more info, see
Kimura (1980), J. Mol. Ev... | [
"Kimura",
"1980",
"model",
".",
"Assumes",
"equal",
"concentrations",
"across",
"nucleotides",
"but",
"allows",
"different",
"rates",
"between",
"transitions",
"and",
"transversions",
".",
"The",
"ratio",
"of",
"the",
"transversion",
"/",
"transition",
"rates",
"i... | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/nuc_models.py#L36-L61 | [
"def",
"K80",
"(",
"mu",
"=",
"1.",
",",
"kappa",
"=",
"0.1",
",",
"*",
"*",
"kwargs",
")",
":",
"num_chars",
"=",
"len",
"(",
"alphabets",
"[",
"'nuc_nogap'",
"]",
")",
"pi",
"=",
"np",
".",
"ones",
"(",
"len",
"(",
"alphabets",
"[",
"'nuc_nogap... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | F81 | Felsenstein 1981 model. Assumes non-equal concentrations across nucleotides,
but the transition rate between all states is assumed to be equal. See
Felsenstein (1981), J. Mol. Evol. 17 (6): 368–376. doi:10.1007/BF01734359
for details.
Current implementation of the model does not account for the gaps (... | treetime/nuc_models.py | def F81(mu=1.0, pi=None, alphabet="nuc", **kwargs):
"""
Felsenstein 1981 model. Assumes non-equal concentrations across nucleotides,
but the transition rate between all states is assumed to be equal. See
Felsenstein (1981), J. Mol. Evol. 17 (6): 368–376. doi:10.1007/BF01734359
for details.
Cur... | def F81(mu=1.0, pi=None, alphabet="nuc", **kwargs):
"""
Felsenstein 1981 model. Assumes non-equal concentrations across nucleotides,
but the transition rate between all states is assumed to be equal. See
Felsenstein (1981), J. Mol. Evol. 17 (6): 368–376. doi:10.1007/BF01734359
for details.
Cur... | [
"Felsenstein",
"1981",
"model",
".",
"Assumes",
"non",
"-",
"equal",
"concentrations",
"across",
"nucleotides",
"but",
"the",
"transition",
"rate",
"between",
"all",
"states",
"is",
"assumed",
"to",
"be",
"equal",
".",
"See",
"Felsenstein",
"(",
"1981",
")",
... | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/nuc_models.py#L63-L103 | [
"def",
"F81",
"(",
"mu",
"=",
"1.0",
",",
"pi",
"=",
"None",
",",
"alphabet",
"=",
"\"nuc\"",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"pi",
"is",
"None",
":",
"pi",
"=",
"0.25",
"*",
"np",
".",
"ones",
"(",
"4",
",",
"dtype",
"=",
"float",
... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | HKY85 | Hasegawa, Kishino and Yano 1985 model. Allows different concentrations of the
nucleotides (as in F81) + distinguishes between transition/transversionsubstitutions
(similar to K80). Link:
Hasegawa, Kishino, Yano (1985), J. Mol. Evol. 22 (2): 160–174. doi:10.1007/BF02101694
Current implementation of the ... | treetime/nuc_models.py | def HKY85(mu=1.0, pi=None, kappa=0.1, **kwargs):
"""
Hasegawa, Kishino and Yano 1985 model. Allows different concentrations of the
nucleotides (as in F81) + distinguishes between transition/transversionsubstitutions
(similar to K80). Link:
Hasegawa, Kishino, Yano (1985), J. Mol. Evol. 22 (2): 160–17... | def HKY85(mu=1.0, pi=None, kappa=0.1, **kwargs):
"""
Hasegawa, Kishino and Yano 1985 model. Allows different concentrations of the
nucleotides (as in F81) + distinguishes between transition/transversionsubstitutions
(similar to K80). Link:
Hasegawa, Kishino, Yano (1985), J. Mol. Evol. 22 (2): 160–17... | [
"Hasegawa",
"Kishino",
"and",
"Yano",
"1985",
"model",
".",
"Allows",
"different",
"concentrations",
"of",
"the",
"nucleotides",
"(",
"as",
"in",
"F81",
")",
"+",
"distinguishes",
"between",
"transition",
"/",
"transversionsubstitutions",
"(",
"similar",
"to",
"... | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/nuc_models.py#L105-L141 | [
"def",
"HKY85",
"(",
"mu",
"=",
"1.0",
",",
"pi",
"=",
"None",
",",
"kappa",
"=",
"0.1",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"pi",
"is",
"None",
":",
"pi",
"=",
"0.25",
"*",
"np",
".",
"ones",
"(",
"4",
",",
"dtype",
"=",
"float",
")",... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | T92 | Tamura 1992 model. Extending Kimura (1980) model for the case where a
G+C-content bias exists. Link:
Tamura K (1992), Mol. Biol. Evol. 9 (4): 678–687. DOI: 10.1093/oxfordjournals.molbev.a040752
Current implementation of the model does not account for the gaps
Parameters
-----------
mu : ... | treetime/nuc_models.py | def T92(mu=1.0, pi_GC=0.5, kappa=0.1, **kwargs):
"""
Tamura 1992 model. Extending Kimura (1980) model for the case where a
G+C-content bias exists. Link:
Tamura K (1992), Mol. Biol. Evol. 9 (4): 678–687. DOI: 10.1093/oxfordjournals.molbev.a040752
Current implementation of the model does not acc... | def T92(mu=1.0, pi_GC=0.5, kappa=0.1, **kwargs):
"""
Tamura 1992 model. Extending Kimura (1980) model for the case where a
G+C-content bias exists. Link:
Tamura K (1992), Mol. Biol. Evol. 9 (4): 678–687. DOI: 10.1093/oxfordjournals.molbev.a040752
Current implementation of the model does not acc... | [
"Tamura",
"1992",
"model",
".",
"Extending",
"Kimura",
"(",
"1980",
")",
"model",
"for",
"the",
"case",
"where",
"a",
"G",
"+",
"C",
"-",
"content",
"bias",
"exists",
".",
"Link",
":",
"Tamura",
"K",
"(",
"1992",
")",
"Mol",
".",
"Biol",
".",
"Evol... | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/nuc_models.py#L143-L172 | [
"def",
"T92",
"(",
"mu",
"=",
"1.0",
",",
"pi_GC",
"=",
"0.5",
",",
"kappa",
"=",
"0.1",
",",
"*",
"*",
"kwargs",
")",
":",
"W",
"=",
"_create_transversion_transition_W",
"(",
"kappa",
")",
"# A C G T",
"if",
"pi_CG",
">=",
"1.",
":",
"raise",
"Value... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | TN93 | Tamura and Nei 1993. The model distinguishes between the two different types of
transition: (A <-> G) is allowed to have a different rate to (C<->T).
Transversions have the same rate. The frequencies of the nucleotides are allowed
to be different. Link:
Tamura, Nei (1993), MolBiol Evol. 10 (3): 512–526.... | treetime/nuc_models.py | def TN93(mu=1.0, kappa1=1., kappa2=1., pi=None, **kwargs):
"""
Tamura and Nei 1993. The model distinguishes between the two different types of
transition: (A <-> G) is allowed to have a different rate to (C<->T).
Transversions have the same rate. The frequencies of the nucleotides are allowed
to be ... | def TN93(mu=1.0, kappa1=1., kappa2=1., pi=None, **kwargs):
"""
Tamura and Nei 1993. The model distinguishes between the two different types of
transition: (A <-> G) is allowed to have a different rate to (C<->T).
Transversions have the same rate. The frequencies of the nucleotides are allowed
to be ... | [
"Tamura",
"and",
"Nei",
"1993",
".",
"The",
"model",
"distinguishes",
"between",
"the",
"two",
"different",
"types",
"of",
"transition",
":",
"(",
"A",
"<",
"-",
">",
"G",
")",
"is",
"allowed",
"to",
"have",
"a",
"different",
"rate",
"to",
"(",
"C<",
... | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/nuc_models.py#L174-L220 | [
"def",
"TN93",
"(",
"mu",
"=",
"1.0",
",",
"kappa1",
"=",
"1.",
",",
"kappa2",
"=",
"1.",
",",
"pi",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"pi",
"is",
"None",
":",
"pi",
"=",
"0.25",
"*",
"np",
".",
"ones",
"(",
"4",
",",
... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | _create_transversion_transition_W | Alphabet = [A, C, G, T] | treetime/nuc_models.py | def _create_transversion_transition_W(kappa):
"""
Alphabet = [A, C, G, T]
"""
W = np.ones((4,4))
W[0, 2]=W[1, 3]=W[2, 0]=W[3,1]=kappa
return W | def _create_transversion_transition_W(kappa):
"""
Alphabet = [A, C, G, T]
"""
W = np.ones((4,4))
W[0, 2]=W[1, 3]=W[2, 0]=W[3,1]=kappa
return W | [
"Alphabet",
"=",
"[",
"A",
"C",
"G",
"T",
"]"
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/nuc_models.py#L222-L228 | [
"def",
"_create_transversion_transition_W",
"(",
"kappa",
")",
":",
"W",
"=",
"np",
".",
"ones",
"(",
"(",
"4",
",",
"4",
")",
")",
"W",
"[",
"0",
",",
"2",
"]",
"=",
"W",
"[",
"1",
",",
"3",
"]",
"=",
"W",
"[",
"2",
",",
"0",
"]",
"=",
"... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | Coalescent.set_Tc | initialize the merger model with a coalescent time
Args:
- Tc: a float or an iterable, if iterable another argument T of same shape is required
- T: an array like of same shape as Tc that specifies the time pivots corresponding to Tc
Returns:
- None | treetime/merger_models.py | def set_Tc(self, Tc, T=None):
'''
initialize the merger model with a coalescent time
Args:
- Tc: a float or an iterable, if iterable another argument T of same shape is required
- T: an array like of same shape as Tc that specifies the time pivots corresponding to T... | def set_Tc(self, Tc, T=None):
'''
initialize the merger model with a coalescent time
Args:
- Tc: a float or an iterable, if iterable another argument T of same shape is required
- T: an array like of same shape as Tc that specifies the time pivots corresponding to T... | [
"initialize",
"the",
"merger",
"model",
"with",
"a",
"coalescent",
"time"
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/merger_models.py#L29-L50 | [
"def",
"set_Tc",
"(",
"self",
",",
"Tc",
",",
"T",
"=",
"None",
")",
":",
"if",
"isinstance",
"(",
"Tc",
",",
"Iterable",
")",
":",
"if",
"len",
"(",
"Tc",
")",
"==",
"len",
"(",
"T",
")",
":",
"x",
"=",
"np",
".",
"concatenate",
"(",
"(",
... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | Coalescent.calc_branch_count | calculates an interpolation object that maps time to the number of
concurrent branches in the tree. The result is stored in self.nbranches | treetime/merger_models.py | def calc_branch_count(self):
'''
calculates an interpolation object that maps time to the number of
concurrent branches in the tree. The result is stored in self.nbranches
'''
# make a list of (time, merger or loss event) by root first iteration
self.tree_events = np.arr... | def calc_branch_count(self):
'''
calculates an interpolation object that maps time to the number of
concurrent branches in the tree. The result is stored in self.nbranches
'''
# make a list of (time, merger or loss event) by root first iteration
self.tree_events = np.arr... | [
"calculates",
"an",
"interpolation",
"object",
"that",
"maps",
"time",
"to",
"the",
"number",
"of",
"concurrent",
"branches",
"in",
"the",
"tree",
".",
"The",
"result",
"is",
"stored",
"in",
"self",
".",
"nbranches"
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/merger_models.py#L53-L84 | [
"def",
"calc_branch_count",
"(",
"self",
")",
":",
"# make a list of (time, merger or loss event) by root first iteration",
"self",
".",
"tree_events",
"=",
"np",
".",
"array",
"(",
"sorted",
"(",
"[",
"(",
"n",
".",
"time_before_present",
",",
"len",
"(",
"n",
".... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | Coalescent.calc_integral_merger_rate | calculates the integral int_0^t (k(t')-1)/2Tc(t') dt' and stores it as
self.integral_merger_rate. This differences of this quantity evaluated at
different times points are the cost of a branch. | treetime/merger_models.py | def calc_integral_merger_rate(self):
'''
calculates the integral int_0^t (k(t')-1)/2Tc(t') dt' and stores it as
self.integral_merger_rate. This differences of this quantity evaluated at
different times points are the cost of a branch.
'''
# integrate the piecewise constan... | def calc_integral_merger_rate(self):
'''
calculates the integral int_0^t (k(t')-1)/2Tc(t') dt' and stores it as
self.integral_merger_rate. This differences of this quantity evaluated at
different times points are the cost of a branch.
'''
# integrate the piecewise constan... | [
"calculates",
"the",
"integral",
"int_0^t",
"(",
"k",
"(",
"t",
")",
"-",
"1",
")",
"/",
"2Tc",
"(",
"t",
")",
"dt",
"and",
"stores",
"it",
"as",
"self",
".",
"integral_merger_rate",
".",
"This",
"differences",
"of",
"this",
"quantity",
"evaluated",
"a... | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/merger_models.py#L87-L103 | [
"def",
"calc_integral_merger_rate",
"(",
"self",
")",
":",
"# integrate the piecewise constant branch count function.",
"tvals",
"=",
"np",
".",
"unique",
"(",
"self",
".",
"nbranches",
".",
"x",
"[",
"1",
":",
"-",
"1",
"]",
")",
"rate",
"=",
"self",
".",
"... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | Coalescent.cost | returns the cost associated with a branch starting at t_node
t_node is time before present, the branch goes back in time
Args:
- t_node: time of the node
- branch_length: branch length, determines when this branch merges with sister
- multiplicity: 2... | treetime/merger_models.py | def cost(self, t_node, branch_length, multiplicity=2.0):
'''
returns the cost associated with a branch starting at t_node
t_node is time before present, the branch goes back in time
Args:
- t_node: time of the node
- branch_length: branch length, det... | def cost(self, t_node, branch_length, multiplicity=2.0):
'''
returns the cost associated with a branch starting at t_node
t_node is time before present, the branch goes back in time
Args:
- t_node: time of the node
- branch_length: branch length, det... | [
"returns",
"the",
"cost",
"associated",
"with",
"a",
"branch",
"starting",
"at",
"t_node",
"t_node",
"is",
"time",
"before",
"present",
"the",
"branch",
"goes",
"back",
"in",
"time"
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/merger_models.py#L121-L133 | [
"def",
"cost",
"(",
"self",
",",
"t_node",
",",
"branch_length",
",",
"multiplicity",
"=",
"2.0",
")",
":",
"merger_time",
"=",
"t_node",
"+",
"branch_length",
"return",
"self",
".",
"integral_merger_rate",
"(",
"merger_time",
")",
"-",
"self",
".",
"integra... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | Coalescent.attach_to_tree | attaches the the merger cost to each branch length interpolator in the tree. | treetime/merger_models.py | def attach_to_tree(self):
'''
attaches the the merger cost to each branch length interpolator in the tree.
'''
for clade in self.tree.find_clades():
if clade.up is not None:
clade.branch_length_interpolator.merger_cost = self.cost | def attach_to_tree(self):
'''
attaches the the merger cost to each branch length interpolator in the tree.
'''
for clade in self.tree.find_clades():
if clade.up is not None:
clade.branch_length_interpolator.merger_cost = self.cost | [
"attaches",
"the",
"the",
"merger",
"cost",
"to",
"each",
"branch",
"length",
"interpolator",
"in",
"the",
"tree",
"."
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/merger_models.py#L136-L142 | [
"def",
"attach_to_tree",
"(",
"self",
")",
":",
"for",
"clade",
"in",
"self",
".",
"tree",
".",
"find_clades",
"(",
")",
":",
"if",
"clade",
".",
"up",
"is",
"not",
"None",
":",
"clade",
".",
"branch_length_interpolator",
".",
"merger_cost",
"=",
"self",... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | Coalescent.optimize_Tc | determines the coalescent time scale that optimizes the coalescent likelihood of the tree | treetime/merger_models.py | def optimize_Tc(self):
'''
determines the coalescent time scale that optimizes the coalescent likelihood of the tree
'''
from scipy.optimize import minimize_scalar
initial_Tc = self.Tc
def cost(Tc):
self.set_Tc(Tc)
return -self.total_LH()
... | def optimize_Tc(self):
'''
determines the coalescent time scale that optimizes the coalescent likelihood of the tree
'''
from scipy.optimize import minimize_scalar
initial_Tc = self.Tc
def cost(Tc):
self.set_Tc(Tc)
return -self.total_LH()
... | [
"determines",
"the",
"coalescent",
"time",
"scale",
"that",
"optimizes",
"the",
"coalescent",
"likelihood",
"of",
"the",
"tree"
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/merger_models.py#L153-L168 | [
"def",
"optimize_Tc",
"(",
"self",
")",
":",
"from",
"scipy",
".",
"optimize",
"import",
"minimize_scalar",
"initial_Tc",
"=",
"self",
".",
"Tc",
"def",
"cost",
"(",
"Tc",
")",
":",
"self",
".",
"set_Tc",
"(",
"Tc",
")",
"return",
"-",
"self",
".",
"... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | Coalescent.optimize_skyline | optimize the trajectory of the merger rate 1./T_c to maximize the
coalescent likelihood.
parameters:
n_points -- number of pivots of the Tc interpolation object
stiffness -- penalty for rapid changes in log(Tc)
methods -- method used to optimize
... | treetime/merger_models.py | def optimize_skyline(self, n_points=20, stiffness=2.0, method = 'SLSQP',
tol=0.03, regularization=10.0, **kwarks):
'''
optimize the trajectory of the merger rate 1./T_c to maximize the
coalescent likelihood.
parameters:
n_points -- number of pivot... | def optimize_skyline(self, n_points=20, stiffness=2.0, method = 'SLSQP',
tol=0.03, regularization=10.0, **kwarks):
'''
optimize the trajectory of the merger rate 1./T_c to maximize the
coalescent likelihood.
parameters:
n_points -- number of pivot... | [
"optimize",
"the",
"trajectory",
"of",
"the",
"merger",
"rate",
"1",
".",
"/",
"T_c",
"to",
"maximize",
"the",
"coalescent",
"likelihood",
".",
"parameters",
":",
"n_points",
"--",
"number",
"of",
"pivots",
"of",
"the",
"Tc",
"interpolation",
"object",
"stif... | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/merger_models.py#L171-L216 | [
"def",
"optimize_skyline",
"(",
"self",
",",
"n_points",
"=",
"20",
",",
"stiffness",
"=",
"2.0",
",",
"method",
"=",
"'SLSQP'",
",",
"tol",
"=",
"0.03",
",",
"regularization",
"=",
"10.0",
",",
"*",
"*",
"kwarks",
")",
":",
"self",
".",
"logger",
"(... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | Coalescent.skyline_empirical | returns the skyline, i.e., an estimate of the inverse rate of coalesence.
Here, the skyline is estimated from a sliding window average of the observed
mergers, i.e., without reference to the coalescence likelihood.
parameters:
gen -- number of generations per year. | treetime/merger_models.py | def skyline_empirical(self, gen=1.0, n_points = 20):
'''
returns the skyline, i.e., an estimate of the inverse rate of coalesence.
Here, the skyline is estimated from a sliding window average of the observed
mergers, i.e., without reference to the coalescence likelihood.
paramete... | def skyline_empirical(self, gen=1.0, n_points = 20):
'''
returns the skyline, i.e., an estimate of the inverse rate of coalesence.
Here, the skyline is estimated from a sliding window average of the observed
mergers, i.e., without reference to the coalescence likelihood.
paramete... | [
"returns",
"the",
"skyline",
"i",
".",
"e",
".",
"an",
"estimate",
"of",
"the",
"inverse",
"rate",
"of",
"coalesence",
".",
"Here",
"the",
"skyline",
"is",
"estimated",
"from",
"a",
"sliding",
"window",
"average",
"of",
"the",
"observed",
"mergers",
"i",
... | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/merger_models.py#L219-L252 | [
"def",
"skyline_empirical",
"(",
"self",
",",
"gen",
"=",
"1.0",
",",
"n_points",
"=",
"20",
")",
":",
"mergers",
"=",
"self",
".",
"tree_events",
"[",
":",
",",
"1",
"]",
">",
"0",
"merger_tvals",
"=",
"self",
".",
"tree_events",
"[",
"mergers",
","... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | Coalescent.skyline_inferred | return the skyline, i.e., an estimate of the inverse rate of coalesence.
This function merely returns the merger rate self.Tc that was set or
estimated by other means. If it was determined using self.optimize_skyline,
the returned skyline will maximize the coalescent likelihood.
paramete... | treetime/merger_models.py | def skyline_inferred(self, gen=1.0, confidence=False):
'''
return the skyline, i.e., an estimate of the inverse rate of coalesence.
This function merely returns the merger rate self.Tc that was set or
estimated by other means. If it was determined using self.optimize_skyline,
the... | def skyline_inferred(self, gen=1.0, confidence=False):
'''
return the skyline, i.e., an estimate of the inverse rate of coalesence.
This function merely returns the merger rate self.Tc that was set or
estimated by other means. If it was determined using self.optimize_skyline,
the... | [
"return",
"the",
"skyline",
"i",
".",
"e",
".",
"an",
"estimate",
"of",
"the",
"inverse",
"rate",
"of",
"coalesence",
".",
"This",
"function",
"merely",
"returns",
"the",
"merger",
"rate",
"self",
".",
"Tc",
"that",
"was",
"set",
"or",
"estimated",
"by",... | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/merger_models.py#L255-L275 | [
"def",
"skyline_inferred",
"(",
"self",
",",
"gen",
"=",
"1.0",
",",
"confidence",
"=",
"False",
")",
":",
"if",
"len",
"(",
"self",
".",
"Tc",
".",
"x",
")",
"<=",
"2",
":",
"print",
"(",
"\"no skyline has been inferred, returning constant population size\"",... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
test | seq2array | Take the raw sequence, substitute the "overhanging" gaps with 'N' (missequenced),
and convert the sequence to the numpy array of chars.
Parameters
----------
seq : Biopython.SeqRecord, str, iterable
Sequence as an object of SeqRecord, string or iterable
fill_overhangs : bool
If T... | treetime/seq_utils.py | def seq2array(seq, fill_overhangs=True, ambiguous_character='N'):
"""
Take the raw sequence, substitute the "overhanging" gaps with 'N' (missequenced),
and convert the sequence to the numpy array of chars.
Parameters
----------
seq : Biopython.SeqRecord, str, iterable
Sequence as an ob... | def seq2array(seq, fill_overhangs=True, ambiguous_character='N'):
"""
Take the raw sequence, substitute the "overhanging" gaps with 'N' (missequenced),
and convert the sequence to the numpy array of chars.
Parameters
----------
seq : Biopython.SeqRecord, str, iterable
Sequence as an ob... | [
"Take",
"the",
"raw",
"sequence",
"substitute",
"the",
"overhanging",
"gaps",
"with",
"N",
"(",
"missequenced",
")",
"and",
"convert",
"the",
"sequence",
"to",
"the",
"numpy",
"array",
"of",
"chars",
"."
] | neherlab/treetime | python | https://github.com/neherlab/treetime/blob/f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0/treetime/seq_utils.py#L118-L150 | [
"def",
"seq2array",
"(",
"seq",
",",
"fill_overhangs",
"=",
"True",
",",
"ambiguous_character",
"=",
"'N'",
")",
":",
"try",
":",
"sequence",
"=",
"''",
".",
"join",
"(",
"seq",
")",
"except",
"TypeError",
":",
"sequence",
"=",
"seq",
"sequence",
"=",
... | f6cdb58d19243a18ffdaa2b2ec71872fa00e65c0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.