repo
stringlengths
7
55
path
stringlengths
4
223
func_name
stringlengths
1
134
original_string
stringlengths
75
104k
language
stringclasses
1 value
code
stringlengths
75
104k
code_tokens
listlengths
19
28.4k
docstring
stringlengths
1
46.9k
docstring_tokens
listlengths
1
1.97k
sha
stringlengths
40
40
url
stringlengths
87
315
partition
stringclasses
1 value
quantopian/zipline
zipline/data/benchmarks.py
get_benchmark_returns
def get_benchmark_returns(symbol): """ Get a Series of benchmark returns from IEX associated with `symbol`. Default is `SPY`. Parameters ---------- symbol : str Benchmark symbol for which we're getting the returns. The data is provided by IEX (https://iextrading.com/), and we can ...
python
def get_benchmark_returns(symbol): """ Get a Series of benchmark returns from IEX associated with `symbol`. Default is `SPY`. Parameters ---------- symbol : str Benchmark symbol for which we're getting the returns. The data is provided by IEX (https://iextrading.com/), and we can ...
[ "def", "get_benchmark_returns", "(", "symbol", ")", ":", "r", "=", "requests", ".", "get", "(", "'https://api.iextrading.com/1.0/stock/{}/chart/5y'", ".", "format", "(", "symbol", ")", ")", "data", "=", "r", ".", "json", "(", ")", "df", "=", "pd", ".", "Da...
Get a Series of benchmark returns from IEX associated with `symbol`. Default is `SPY`. Parameters ---------- symbol : str Benchmark symbol for which we're getting the returns. The data is provided by IEX (https://iextrading.com/), and we can get up to 5 years worth of data.
[ "Get", "a", "Series", "of", "benchmark", "returns", "from", "IEX", "associated", "with", "symbol", ".", "Default", "is", "SPY", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/benchmarks.py#L19-L42
train
quantopian/zipline
zipline/pipeline/visualize.py
delimit
def delimit(delimiters, content): """ Surround `content` with the first and last characters of `delimiters`. >>> delimit('[]', "foo") # doctest: +SKIP '[foo]' >>> delimit('""', "foo") # doctest: +SKIP '"foo"' """ if len(delimiters) != 2: raise ValueError( "`delimit...
python
def delimit(delimiters, content): """ Surround `content` with the first and last characters of `delimiters`. >>> delimit('[]', "foo") # doctest: +SKIP '[foo]' >>> delimit('""', "foo") # doctest: +SKIP '"foo"' """ if len(delimiters) != 2: raise ValueError( "`delimit...
[ "def", "delimit", "(", "delimiters", ",", "content", ")", ":", "if", "len", "(", "delimiters", ")", "!=", "2", ":", "raise", "ValueError", "(", "\"`delimiters` must be of length 2. Got %r\"", "%", "delimiters", ")", "return", "''", ".", "join", "(", "[", "de...
Surround `content` with the first and last characters of `delimiters`. >>> delimit('[]', "foo") # doctest: +SKIP '[foo]' >>> delimit('""', "foo") # doctest: +SKIP '"foo"'
[ "Surround", "content", "with", "the", "first", "and", "last", "characters", "of", "delimiters", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/visualize.py#L24-L37
train
quantopian/zipline
zipline/pipeline/visualize.py
roots
def roots(g): "Get nodes from graph G with indegree 0" return set(n for n, d in iteritems(g.in_degree()) if d == 0)
python
def roots(g): "Get nodes from graph G with indegree 0" return set(n for n, d in iteritems(g.in_degree()) if d == 0)
[ "def", "roots", "(", "g", ")", ":", "return", "set", "(", "n", "for", "n", ",", "d", "in", "iteritems", "(", "g", ".", "in_degree", "(", ")", ")", "if", "d", "==", "0", ")" ]
Get nodes from graph G with indegree 0
[ "Get", "nodes", "from", "graph", "G", "with", "indegree", "0" ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/visualize.py#L73-L75
train
quantopian/zipline
zipline/pipeline/visualize.py
_render
def _render(g, out, format_, include_asset_exists=False): """ Draw `g` as a graph to `out`, in format `format`. Parameters ---------- g : zipline.pipeline.graph.TermGraph Graph to render. out : file-like object format_ : str {'png', 'svg'} Output format. include_asset_ex...
python
def _render(g, out, format_, include_asset_exists=False): """ Draw `g` as a graph to `out`, in format `format`. Parameters ---------- g : zipline.pipeline.graph.TermGraph Graph to render. out : file-like object format_ : str {'png', 'svg'} Output format. include_asset_ex...
[ "def", "_render", "(", "g", ",", "out", ",", "format_", ",", "include_asset_exists", "=", "False", ")", ":", "graph_attrs", "=", "{", "'rankdir'", ":", "'TB'", ",", "'splines'", ":", "'ortho'", "}", "cluster_attrs", "=", "{", "'style'", ":", "'filled'", ...
Draw `g` as a graph to `out`, in format `format`. Parameters ---------- g : zipline.pipeline.graph.TermGraph Graph to render. out : file-like object format_ : str {'png', 'svg'} Output format. include_asset_exists : bool Whether to filter out `AssetExists()` nodes.
[ "Draw", "g", "as", "a", "graph", "to", "out", "in", "format", "format", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/visualize.py#L84-L149
train
quantopian/zipline
zipline/pipeline/visualize.py
display_graph
def display_graph(g, format='svg', include_asset_exists=False): """ Display a TermGraph interactively from within IPython. """ try: import IPython.display as display except ImportError: raise NoIPython("IPython is not installed. Can't display graph.") if format == 'svg': ...
python
def display_graph(g, format='svg', include_asset_exists=False): """ Display a TermGraph interactively from within IPython. """ try: import IPython.display as display except ImportError: raise NoIPython("IPython is not installed. Can't display graph.") if format == 'svg': ...
[ "def", "display_graph", "(", "g", ",", "format", "=", "'svg'", ",", "include_asset_exists", "=", "False", ")", ":", "try", ":", "import", "IPython", ".", "display", "as", "display", "except", "ImportError", ":", "raise", "NoIPython", "(", "\"IPython is not ins...
Display a TermGraph interactively from within IPython.
[ "Display", "a", "TermGraph", "interactively", "from", "within", "IPython", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/visualize.py#L152-L168
train
quantopian/zipline
zipline/pipeline/visualize.py
format_attrs
def format_attrs(attrs): """ Format key, value pairs from attrs into graphviz attrs format Examples -------- >>> format_attrs({'key1': 'value1', 'key2': 'value2'}) # doctest: +SKIP '[key1=value1, key2=value2]' """ if not attrs: return '' entries = ['='.join((key, value)) fo...
python
def format_attrs(attrs): """ Format key, value pairs from attrs into graphviz attrs format Examples -------- >>> format_attrs({'key1': 'value1', 'key2': 'value2'}) # doctest: +SKIP '[key1=value1, key2=value2]' """ if not attrs: return '' entries = ['='.join((key, value)) fo...
[ "def", "format_attrs", "(", "attrs", ")", ":", "if", "not", "attrs", ":", "return", "''", "entries", "=", "[", "'='", ".", "join", "(", "(", "key", ",", "value", ")", ")", "for", "key", ",", "value", "in", "iteritems", "(", "attrs", ")", "]", "re...
Format key, value pairs from attrs into graphviz attrs format Examples -------- >>> format_attrs({'key1': 'value1', 'key2': 'value2'}) # doctest: +SKIP '[key1=value1, key2=value2]'
[ "Format", "key", "value", "pairs", "from", "attrs", "into", "graphviz", "attrs", "format" ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/visualize.py#L215-L227
train
quantopian/zipline
zipline/utils/pool.py
SequentialPool.apply_async
def apply_async(f, args=(), kwargs=None, callback=None): """Apply a function but emulate the API of an asynchronous call. Parameters ---------- f : callable The function to call. args : tuple, optional The positional arguments. kwargs : dict, opti...
python
def apply_async(f, args=(), kwargs=None, callback=None): """Apply a function but emulate the API of an asynchronous call. Parameters ---------- f : callable The function to call. args : tuple, optional The positional arguments. kwargs : dict, opti...
[ "def", "apply_async", "(", "f", ",", "args", "=", "(", ")", ",", "kwargs", "=", "None", ",", "callback", "=", "None", ")", ":", "try", ":", "value", "=", "(", "identity", "if", "callback", "is", "None", "else", "callback", ")", "(", "f", "(", "*"...
Apply a function but emulate the API of an asynchronous call. Parameters ---------- f : callable The function to call. args : tuple, optional The positional arguments. kwargs : dict, optional The keyword arguments. Returns ---...
[ "Apply", "a", "function", "but", "emulate", "the", "API", "of", "an", "asynchronous", "call", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/utils/pool.py#L84-L116
train
quantopian/zipline
zipline/utils/cli.py
maybe_show_progress
def maybe_show_progress(it, show_progress, **kwargs): """Optionally show a progress bar for the given iterator. Parameters ---------- it : iterable The underlying iterator. show_progress : bool Should progress be shown. **kwargs Forwarded to the click progress bar. ...
python
def maybe_show_progress(it, show_progress, **kwargs): """Optionally show a progress bar for the given iterator. Parameters ---------- it : iterable The underlying iterator. show_progress : bool Should progress be shown. **kwargs Forwarded to the click progress bar. ...
[ "def", "maybe_show_progress", "(", "it", ",", "show_progress", ",", "*", "*", "kwargs", ")", ":", "if", "show_progress", ":", "return", "click", ".", "progressbar", "(", "it", ",", "*", "*", "kwargs", ")", "# context manager that just return `it` when we enter it"...
Optionally show a progress bar for the given iterator. Parameters ---------- it : iterable The underlying iterator. show_progress : bool Should progress be shown. **kwargs Forwarded to the click progress bar. Returns ------- itercontext : context manager ...
[ "Optionally", "show", "a", "progress", "bar", "for", "the", "given", "iterator", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/utils/cli.py#L7-L36
train
quantopian/zipline
zipline/__main__.py
main
def main(extension, strict_extensions, default_extension, x): """Top level zipline entry point. """ # install a logbook handler before performing any other operations logbook.StderrHandler().push_application() create_args(x, zipline.extension_args) load_extensions( default_extension, ...
python
def main(extension, strict_extensions, default_extension, x): """Top level zipline entry point. """ # install a logbook handler before performing any other operations logbook.StderrHandler().push_application() create_args(x, zipline.extension_args) load_extensions( default_extension, ...
[ "def", "main", "(", "extension", ",", "strict_extensions", ",", "default_extension", ",", "x", ")", ":", "# install a logbook handler before performing any other operations", "logbook", ".", "StderrHandler", "(", ")", ".", "push_application", "(", ")", "create_args", "(...
Top level zipline entry point.
[ "Top", "level", "zipline", "entry", "point", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/__main__.py#L49-L61
train
quantopian/zipline
zipline/__main__.py
ipython_only
def ipython_only(option): """Mark that an option should only be exposed in IPython. Parameters ---------- option : decorator A click.option decorator. Returns ------- ipython_only_dec : decorator A decorator that correctly applies the argument even when not using IP...
python
def ipython_only(option): """Mark that an option should only be exposed in IPython. Parameters ---------- option : decorator A click.option decorator. Returns ------- ipython_only_dec : decorator A decorator that correctly applies the argument even when not using IP...
[ "def", "ipython_only", "(", "option", ")", ":", "if", "__IPYTHON__", ":", "return", "option", "argname", "=", "extract_option_object", "(", "option", ")", ".", "name", "def", "d", "(", "f", ")", ":", "@", "wraps", "(", "f", ")", "def", "_", "(", "*",...
Mark that an option should only be exposed in IPython. Parameters ---------- option : decorator A click.option decorator. Returns ------- ipython_only_dec : decorator A decorator that correctly applies the argument even when not using IPython mode.
[ "Mark", "that", "an", "option", "should", "only", "be", "exposed", "in", "IPython", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/__main__.py#L84-L109
train
quantopian/zipline
zipline/__main__.py
run
def run(ctx, algofile, algotext, define, data_frequency, capital_base, bundle, bundle_timestamp, start, end, output, trading_calendar, print_algo, metrics_set, local_namespace, blotter): """Run a ...
python
def run(ctx, algofile, algotext, define, data_frequency, capital_base, bundle, bundle_timestamp, start, end, output, trading_calendar, print_algo, metrics_set, local_namespace, blotter): """Run a ...
[ "def", "run", "(", "ctx", ",", "algofile", ",", "algotext", ",", "define", ",", "data_frequency", ",", "capital_base", ",", "bundle", ",", "bundle_timestamp", ",", "start", ",", "end", ",", "output", ",", "trading_calendar", ",", "print_algo", ",", "metrics_...
Run a backtest for the given algorithm.
[ "Run", "a", "backtest", "for", "the", "given", "algorithm", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/__main__.py#L216-L284
train
quantopian/zipline
zipline/__main__.py
zipline_magic
def zipline_magic(line, cell=None): """The zipline IPython cell magic. """ load_extensions( default=True, extensions=[], strict=True, environ=os.environ, ) try: return run.main( # put our overrides at the start of the parameter list so that ...
python
def zipline_magic(line, cell=None): """The zipline IPython cell magic. """ load_extensions( default=True, extensions=[], strict=True, environ=os.environ, ) try: return run.main( # put our overrides at the start of the parameter list so that ...
[ "def", "zipline_magic", "(", "line", ",", "cell", "=", "None", ")", ":", "load_extensions", "(", "default", "=", "True", ",", "extensions", "=", "[", "]", ",", "strict", "=", "True", ",", "environ", "=", "os", ".", "environ", ",", ")", "try", ":", ...
The zipline IPython cell magic.
[ "The", "zipline", "IPython", "cell", "magic", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/__main__.py#L287-L317
train
quantopian/zipline
zipline/__main__.py
ingest
def ingest(bundle, assets_version, show_progress): """Ingest the data for the given bundle. """ bundles_module.ingest( bundle, os.environ, pd.Timestamp.utcnow(), assets_version, show_progress, )
python
def ingest(bundle, assets_version, show_progress): """Ingest the data for the given bundle. """ bundles_module.ingest( bundle, os.environ, pd.Timestamp.utcnow(), assets_version, show_progress, )
[ "def", "ingest", "(", "bundle", ",", "assets_version", ",", "show_progress", ")", ":", "bundles_module", ".", "ingest", "(", "bundle", ",", "os", ".", "environ", ",", "pd", ".", "Timestamp", ".", "utcnow", "(", ")", ",", "assets_version", ",", "show_progre...
Ingest the data for the given bundle.
[ "Ingest", "the", "data", "for", "the", "given", "bundle", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/__main__.py#L340-L349
train
quantopian/zipline
zipline/__main__.py
clean
def clean(bundle, before, after, keep_last): """Clean up data downloaded with the ingest command. """ bundles_module.clean( bundle, before, after, keep_last, )
python
def clean(bundle, before, after, keep_last): """Clean up data downloaded with the ingest command. """ bundles_module.clean( bundle, before, after, keep_last, )
[ "def", "clean", "(", "bundle", ",", "before", ",", "after", ",", "keep_last", ")", ":", "bundles_module", ".", "clean", "(", "bundle", ",", "before", ",", "after", ",", "keep_last", ",", ")" ]
Clean up data downloaded with the ingest command.
[ "Clean", "up", "data", "downloaded", "with", "the", "ingest", "command", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/__main__.py#L383-L391
train
quantopian/zipline
zipline/__main__.py
bundles
def bundles(): """List all of the available data bundles. """ for bundle in sorted(bundles_module.bundles.keys()): if bundle.startswith('.'): # hide the test data continue try: ingestions = list( map(text_type, bundles_module.ingestions_for...
python
def bundles(): """List all of the available data bundles. """ for bundle in sorted(bundles_module.bundles.keys()): if bundle.startswith('.'): # hide the test data continue try: ingestions = list( map(text_type, bundles_module.ingestions_for...
[ "def", "bundles", "(", ")", ":", "for", "bundle", "in", "sorted", "(", "bundles_module", ".", "bundles", ".", "keys", "(", ")", ")", ":", "if", "bundle", ".", "startswith", "(", "'.'", ")", ":", "# hide the test data", "continue", "try", ":", "ingestions...
List all of the available data bundles.
[ "List", "all", "of", "the", "available", "data", "bundles", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/__main__.py#L395-L415
train
quantopian/zipline
zipline/pipeline/filters/filter.py
binary_operator
def binary_operator(op): """ Factory function for making binary operator methods on a Filter subclass. Returns a function "binary_operator" suitable for implementing functions like __and__ or __or__. """ # When combining a Filter with a NumericalExpression, we use this # attrgetter instance...
python
def binary_operator(op): """ Factory function for making binary operator methods on a Filter subclass. Returns a function "binary_operator" suitable for implementing functions like __and__ or __or__. """ # When combining a Filter with a NumericalExpression, we use this # attrgetter instance...
[ "def", "binary_operator", "(", "op", ")", ":", "# When combining a Filter with a NumericalExpression, we use this", "# attrgetter instance to defer to the commuted interpretation of the", "# NumericalExpression operator.", "commuted_method_getter", "=", "attrgetter", "(", "method_name_for_...
Factory function for making binary operator methods on a Filter subclass. Returns a function "binary_operator" suitable for implementing functions like __and__ or __or__.
[ "Factory", "function", "for", "making", "binary", "operator", "methods", "on", "a", "Filter", "subclass", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/filters/filter.py#L62-L112
train
quantopian/zipline
zipline/pipeline/filters/filter.py
unary_operator
def unary_operator(op): """ Factory function for making unary operator methods for Filters. """ valid_ops = {'~'} if op not in valid_ops: raise ValueError("Invalid unary operator %s." % op) def unary_operator(self): # This can't be hoisted up a scope because the types returned b...
python
def unary_operator(op): """ Factory function for making unary operator methods for Filters. """ valid_ops = {'~'} if op not in valid_ops: raise ValueError("Invalid unary operator %s." % op) def unary_operator(self): # This can't be hoisted up a scope because the types returned b...
[ "def", "unary_operator", "(", "op", ")", ":", "valid_ops", "=", "{", "'~'", "}", "if", "op", "not", "in", "valid_ops", ":", "raise", "ValueError", "(", "\"Invalid unary operator %s.\"", "%", "op", ")", "def", "unary_operator", "(", "self", ")", ":", "# Thi...
Factory function for making unary operator methods for Filters.
[ "Factory", "function", "for", "making", "unary", "operator", "methods", "for", "Filters", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/filters/filter.py#L115-L136
train
quantopian/zipline
zipline/pipeline/filters/filter.py
NumExprFilter.create
def create(cls, expr, binds): """ Helper for creating new NumExprFactors. This is just a wrapper around NumericalExpression.__new__ that always forwards `bool` as the dtype, since Filters can only be of boolean dtype. """ return cls(expr=expr, binds=binds, dtype=...
python
def create(cls, expr, binds): """ Helper for creating new NumExprFactors. This is just a wrapper around NumericalExpression.__new__ that always forwards `bool` as the dtype, since Filters can only be of boolean dtype. """ return cls(expr=expr, binds=binds, dtype=...
[ "def", "create", "(", "cls", ",", "expr", ",", "binds", ")", ":", "return", "cls", "(", "expr", "=", "expr", ",", "binds", "=", "binds", ",", "dtype", "=", "bool_dtype", ")" ]
Helper for creating new NumExprFactors. This is just a wrapper around NumericalExpression.__new__ that always forwards `bool` as the dtype, since Filters can only be of boolean dtype.
[ "Helper", "for", "creating", "new", "NumExprFactors", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/filters/filter.py#L237-L245
train
quantopian/zipline
zipline/pipeline/filters/filter.py
NumExprFilter._compute
def _compute(self, arrays, dates, assets, mask): """ Compute our result with numexpr, then re-apply `mask`. """ return super(NumExprFilter, self)._compute( arrays, dates, assets, mask, ) & mask
python
def _compute(self, arrays, dates, assets, mask): """ Compute our result with numexpr, then re-apply `mask`. """ return super(NumExprFilter, self)._compute( arrays, dates, assets, mask, ) & mask
[ "def", "_compute", "(", "self", ",", "arrays", ",", "dates", ",", "assets", ",", "mask", ")", ":", "return", "super", "(", "NumExprFilter", ",", "self", ")", ".", "_compute", "(", "arrays", ",", "dates", ",", "assets", ",", "mask", ",", ")", "&", "...
Compute our result with numexpr, then re-apply `mask`.
[ "Compute", "our", "result", "with", "numexpr", "then", "re", "-", "apply", "mask", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/filters/filter.py#L247-L256
train
quantopian/zipline
zipline/pipeline/filters/filter.py
PercentileFilter._validate
def _validate(self): """ Ensure that our percentile bounds are well-formed. """ if not 0.0 <= self._min_percentile < self._max_percentile <= 100.0: raise BadPercentileBounds( min_percentile=self._min_percentile, max_percentile=self._max_percent...
python
def _validate(self): """ Ensure that our percentile bounds are well-formed. """ if not 0.0 <= self._min_percentile < self._max_percentile <= 100.0: raise BadPercentileBounds( min_percentile=self._min_percentile, max_percentile=self._max_percent...
[ "def", "_validate", "(", "self", ")", ":", "if", "not", "0.0", "<=", "self", ".", "_min_percentile", "<", "self", ".", "_max_percentile", "<=", "100.0", ":", "raise", "BadPercentileBounds", "(", "min_percentile", "=", "self", ".", "_min_percentile", ",", "ma...
Ensure that our percentile bounds are well-formed.
[ "Ensure", "that", "our", "percentile", "bounds", "are", "well", "-", "formed", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/filters/filter.py#L344-L354
train
quantopian/zipline
zipline/pipeline/filters/filter.py
PercentileFilter._compute
def _compute(self, arrays, dates, assets, mask): """ For each row in the input, compute a mask of all values falling between the given percentiles. """ # TODO: Review whether there's a better way of handling small numbers # of columns. data = arrays[0].copy().asty...
python
def _compute(self, arrays, dates, assets, mask): """ For each row in the input, compute a mask of all values falling between the given percentiles. """ # TODO: Review whether there's a better way of handling small numbers # of columns. data = arrays[0].copy().asty...
[ "def", "_compute", "(", "self", ",", "arrays", ",", "dates", ",", "assets", ",", "mask", ")", ":", "# TODO: Review whether there's a better way of handling small numbers", "# of columns.", "data", "=", "arrays", "[", "0", "]", ".", "copy", "(", ")", ".", "astype...
For each row in the input, compute a mask of all values falling between the given percentiles.
[ "For", "each", "row", "in", "the", "input", "compute", "a", "mask", "of", "all", "values", "falling", "between", "the", "given", "percentiles", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/filters/filter.py#L356-L382
train
quantopian/zipline
zipline/data/treasuries.py
parse_treasury_csv_column
def parse_treasury_csv_column(column): """ Parse a treasury CSV column into a more human-readable format. Columns start with 'RIFLGFC', followed by Y or M (year or month), followed by a two-digit number signifying number of years/months, followed by _N.B. We only care about the middle two entries, ...
python
def parse_treasury_csv_column(column): """ Parse a treasury CSV column into a more human-readable format. Columns start with 'RIFLGFC', followed by Y or M (year or month), followed by a two-digit number signifying number of years/months, followed by _N.B. We only care about the middle two entries, ...
[ "def", "parse_treasury_csv_column", "(", "column", ")", ":", "column_re", "=", "re", ".", "compile", "(", "r\"^(?P<prefix>RIFLGFC)\"", "\"(?P<unit>[YM])\"", "\"(?P<periods>[0-9]{2})\"", "\"(?P<suffix>_N.B)$\"", ")", "match", "=", "column_re", ".", "match", "(", "column"...
Parse a treasury CSV column into a more human-readable format. Columns start with 'RIFLGFC', followed by Y or M (year or month), followed by a two-digit number signifying number of years/months, followed by _N.B. We only care about the middle two entries, which we turn into a string like 3month or 30ye...
[ "Parse", "a", "treasury", "CSV", "column", "into", "a", "more", "human", "-", "readable", "format", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/treasuries.py#L25-L47
train
quantopian/zipline
zipline/data/treasuries.py
get_daily_10yr_treasury_data
def get_daily_10yr_treasury_data(): """Download daily 10 year treasury rates from the Federal Reserve and return a pandas.Series.""" url = "https://www.federalreserve.gov/datadownload/Output.aspx?rel=H15" \ "&series=bcb44e57fb57efbe90002369321bfb3f&lastObs=&from=&to=" \ "&filetype=csv&la...
python
def get_daily_10yr_treasury_data(): """Download daily 10 year treasury rates from the Federal Reserve and return a pandas.Series.""" url = "https://www.federalreserve.gov/datadownload/Output.aspx?rel=H15" \ "&series=bcb44e57fb57efbe90002369321bfb3f&lastObs=&from=&to=" \ "&filetype=csv&la...
[ "def", "get_daily_10yr_treasury_data", "(", ")", ":", "url", "=", "\"https://www.federalreserve.gov/datadownload/Output.aspx?rel=H15\"", "\"&series=bcb44e57fb57efbe90002369321bfb3f&lastObs=&from=&to=\"", "\"&filetype=csv&label=include&layout=seriescolumn\"", "return", "pd", ".", "read_csv"...
Download daily 10 year treasury rates from the Federal Reserve and return a pandas.Series.
[ "Download", "daily", "10", "year", "treasury", "rates", "from", "the", "Federal", "Reserve", "and", "return", "a", "pandas", ".", "Series", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/treasuries.py#L93-L101
train
quantopian/zipline
zipline/data/minute_bars.py
_sid_subdir_path
def _sid_subdir_path(sid): """ Format subdir path to limit the number directories in any given subdirectory to 100. The number in each directory is designed to support at least 100000 equities. Parameters ---------- sid : int Asset identifier. Returns ------- out :...
python
def _sid_subdir_path(sid): """ Format subdir path to limit the number directories in any given subdirectory to 100. The number in each directory is designed to support at least 100000 equities. Parameters ---------- sid : int Asset identifier. Returns ------- out :...
[ "def", "_sid_subdir_path", "(", "sid", ")", ":", "padded_sid", "=", "format", "(", "sid", ",", "'06'", ")", "return", "os", ".", "path", ".", "join", "(", "# subdir 1 00/XX", "padded_sid", "[", "0", ":", "2", "]", ",", "# subdir 2 XX/00", "padded_sid", "...
Format subdir path to limit the number directories in any given subdirectory to 100. The number in each directory is designed to support at least 100000 equities. Parameters ---------- sid : int Asset identifier. Returns ------- out : string A path for the bcolz ro...
[ "Format", "subdir", "path", "to", "limit", "the", "number", "directories", "in", "any", "given", "subdirectory", "to", "100", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L85-L113
train
quantopian/zipline
zipline/data/minute_bars.py
convert_cols
def convert_cols(cols, scale_factor, sid, invalid_data_behavior): """Adapt OHLCV columns into uint32 columns. Parameters ---------- cols : dict A dict mapping each column name (open, high, low, close, volume) to a float column to convert to uint32. scale_factor : int Factor ...
python
def convert_cols(cols, scale_factor, sid, invalid_data_behavior): """Adapt OHLCV columns into uint32 columns. Parameters ---------- cols : dict A dict mapping each column name (open, high, low, close, volume) to a float column to convert to uint32. scale_factor : int Factor ...
[ "def", "convert_cols", "(", "cols", ",", "scale_factor", ",", "sid", ",", "invalid_data_behavior", ")", ":", "scaled_opens", "=", "(", "np", ".", "nan_to_num", "(", "cols", "[", "'open'", "]", ")", "*", "scale_factor", ")", ".", "round", "(", ")", "scale...
Adapt OHLCV columns into uint32 columns. Parameters ---------- cols : dict A dict mapping each column name (open, high, low, close, volume) to a float column to convert to uint32. scale_factor : int Factor to use to scale float values before converting to uint32. sid : int ...
[ "Adapt", "OHLCV", "columns", "into", "uint32", "columns", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L116-L180
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarMetadata.write
def write(self, rootdir): """ Write the metadata to a JSON file in the rootdir. Values contained in the metadata are: version : int The value of FORMAT_VERSION of this class. ohlc_ratio : int The default ratio by which to multiply the pricing data to ...
python
def write(self, rootdir): """ Write the metadata to a JSON file in the rootdir. Values contained in the metadata are: version : int The value of FORMAT_VERSION of this class. ohlc_ratio : int The default ratio by which to multiply the pricing data to ...
[ "def", "write", "(", "self", ",", "rootdir", ")", ":", "calendar", "=", "self", ".", "calendar", "slicer", "=", "calendar", ".", "schedule", ".", "index", ".", "slice_indexer", "(", "self", ".", "start_session", ",", "self", ".", "end_session", ",", ")",...
Write the metadata to a JSON file in the rootdir. Values contained in the metadata are: version : int The value of FORMAT_VERSION of this class. ohlc_ratio : int The default ratio by which to multiply the pricing data to convert the floats from floats to an ...
[ "Write", "the", "metadata", "to", "a", "JSON", "file", "in", "the", "rootdir", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L280-L349
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter.open
def open(cls, rootdir, end_session=None): """ Open an existing ``rootdir`` for writing. Parameters ---------- end_session : Timestamp (optional) When appending, the intended new ``end_session``. """ metadata = BcolzMinuteBarMetadata.read(rootdir) ...
python
def open(cls, rootdir, end_session=None): """ Open an existing ``rootdir`` for writing. Parameters ---------- end_session : Timestamp (optional) When appending, the intended new ``end_session``. """ metadata = BcolzMinuteBarMetadata.read(rootdir) ...
[ "def", "open", "(", "cls", ",", "rootdir", ",", "end_session", "=", "None", ")", ":", "metadata", "=", "BcolzMinuteBarMetadata", ".", "read", "(", "rootdir", ")", "return", "BcolzMinuteBarWriter", "(", "rootdir", ",", "metadata", ".", "calendar", ",", "metad...
Open an existing ``rootdir`` for writing. Parameters ---------- end_session : Timestamp (optional) When appending, the intended new ``end_session``.
[ "Open", "an", "existing", "rootdir", "for", "writing", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L482-L501
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter.sidpath
def sidpath(self, sid): """ Parameters ---------- sid : int Asset identifier. Returns ------- out : string Full path to the bcolz rootdir for the given sid. """ sid_subdir = _sid_subdir_path(sid) return join(self._r...
python
def sidpath(self, sid): """ Parameters ---------- sid : int Asset identifier. Returns ------- out : string Full path to the bcolz rootdir for the given sid. """ sid_subdir = _sid_subdir_path(sid) return join(self._r...
[ "def", "sidpath", "(", "self", ",", "sid", ")", ":", "sid_subdir", "=", "_sid_subdir_path", "(", "sid", ")", "return", "join", "(", "self", ".", "_rootdir", ",", "sid_subdir", ")" ]
Parameters ---------- sid : int Asset identifier. Returns ------- out : string Full path to the bcolz rootdir for the given sid.
[ "Parameters", "----------", "sid", ":", "int", "Asset", "identifier", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L518-L531
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter.last_date_in_output_for_sid
def last_date_in_output_for_sid(self, sid): """ Parameters ---------- sid : int Asset identifier. Returns ------- out : pd.Timestamp The midnight of the last date written in to the output for the given sid. """ ...
python
def last_date_in_output_for_sid(self, sid): """ Parameters ---------- sid : int Asset identifier. Returns ------- out : pd.Timestamp The midnight of the last date written in to the output for the given sid. """ ...
[ "def", "last_date_in_output_for_sid", "(", "self", ",", "sid", ")", ":", "sizes_path", "=", "\"{0}/close/meta/sizes\"", ".", "format", "(", "self", ".", "sidpath", "(", "sid", ")", ")", "if", "not", "os", ".", "path", ".", "exists", "(", "sizes_path", ")",...
Parameters ---------- sid : int Asset identifier. Returns ------- out : pd.Timestamp The midnight of the last date written in to the output for the given sid.
[ "Parameters", "----------", "sid", ":", "int", "Asset", "identifier", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L533-L558
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter._init_ctable
def _init_ctable(self, path): """ Create empty ctable for given path. Parameters ---------- path : string The path to rootdir of the new ctable. """ # Only create the containing subdir on creation. # This is not to be confused with the `.bcolz...
python
def _init_ctable(self, path): """ Create empty ctable for given path. Parameters ---------- path : string The path to rootdir of the new ctable. """ # Only create the containing subdir on creation. # This is not to be confused with the `.bcolz...
[ "def", "_init_ctable", "(", "self", ",", "path", ")", ":", "# Only create the containing subdir on creation.", "# This is not to be confused with the `.bcolz` directory, but is the", "# directory up one level from the `.bcolz` directories.", "sid_containing_dirname", "=", "os", ".", "p...
Create empty ctable for given path. Parameters ---------- path : string The path to rootdir of the new ctable.
[ "Create", "empty", "ctable", "for", "given", "path", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L560-L597
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter._ensure_ctable
def _ensure_ctable(self, sid): """Ensure that a ctable exists for ``sid``, then return it.""" sidpath = self.sidpath(sid) if not os.path.exists(sidpath): return self._init_ctable(sidpath) return bcolz.ctable(rootdir=sidpath, mode='a')
python
def _ensure_ctable(self, sid): """Ensure that a ctable exists for ``sid``, then return it.""" sidpath = self.sidpath(sid) if not os.path.exists(sidpath): return self._init_ctable(sidpath) return bcolz.ctable(rootdir=sidpath, mode='a')
[ "def", "_ensure_ctable", "(", "self", ",", "sid", ")", ":", "sidpath", "=", "self", ".", "sidpath", "(", "sid", ")", "if", "not", "os", ".", "path", ".", "exists", "(", "sidpath", ")", ":", "return", "self", ".", "_init_ctable", "(", "sidpath", ")", ...
Ensure that a ctable exists for ``sid``, then return it.
[ "Ensure", "that", "a", "ctable", "exists", "for", "sid", "then", "return", "it", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L599-L604
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter.pad
def pad(self, sid, date): """ Fill sid container with empty data through the specified date. If the last recorded trade is not at the close, then that day will be padded with zeros until its close. Any day after that (up to and including the specified date) will be padded with `...
python
def pad(self, sid, date): """ Fill sid container with empty data through the specified date. If the last recorded trade is not at the close, then that day will be padded with zeros until its close. Any day after that (up to and including the specified date) will be padded with `...
[ "def", "pad", "(", "self", ",", "sid", ",", "date", ")", ":", "table", "=", "self", ".", "_ensure_ctable", "(", "sid", ")", "last_date", "=", "self", ".", "last_date_in_output_for_sid", "(", "sid", ")", "tds", "=", "self", ".", "_session_labels", "if", ...
Fill sid container with empty data through the specified date. If the last recorded trade is not at the close, then that day will be padded with zeros until its close. Any day after that (up to and including the specified date) will be padded with `minute_per_day` worth of zeros ...
[ "Fill", "sid", "container", "with", "empty", "data", "through", "the", "specified", "date", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L618-L659
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter.set_sid_attrs
def set_sid_attrs(self, sid, **kwargs): """Write all the supplied kwargs as attributes of the sid's file. """ table = self._ensure_ctable(sid) for k, v in kwargs.items(): table.attrs[k] = v
python
def set_sid_attrs(self, sid, **kwargs): """Write all the supplied kwargs as attributes of the sid's file. """ table = self._ensure_ctable(sid) for k, v in kwargs.items(): table.attrs[k] = v
[ "def", "set_sid_attrs", "(", "self", ",", "sid", ",", "*", "*", "kwargs", ")", ":", "table", "=", "self", ".", "_ensure_ctable", "(", "sid", ")", "for", "k", ",", "v", "in", "kwargs", ".", "items", "(", ")", ":", "table", ".", "attrs", "[", "k", ...
Write all the supplied kwargs as attributes of the sid's file.
[ "Write", "all", "the", "supplied", "kwargs", "as", "attributes", "of", "the", "sid", "s", "file", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L661-L666
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter.write
def write(self, data, show_progress=False, invalid_data_behavior='warn'): """Write a stream of minute data. Parameters ---------- data : iterable[(int, pd.DataFrame)] The data to write. Each element should be a tuple of sid, data where data has the following form...
python
def write(self, data, show_progress=False, invalid_data_behavior='warn'): """Write a stream of minute data. Parameters ---------- data : iterable[(int, pd.DataFrame)] The data to write. Each element should be a tuple of sid, data where data has the following form...
[ "def", "write", "(", "self", ",", "data", ",", "show_progress", "=", "False", ",", "invalid_data_behavior", "=", "'warn'", ")", ":", "ctx", "=", "maybe_show_progress", "(", "data", ",", "show_progress", "=", "show_progress", ",", "item_show_func", "=", "lambda...
Write a stream of minute data. Parameters ---------- data : iterable[(int, pd.DataFrame)] The data to write. Each element should be a tuple of sid, data where data has the following format: columns : ('open', 'high', 'low', 'close', 'volume') ...
[ "Write", "a", "stream", "of", "minute", "data", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L668-L697
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter.write_sid
def write_sid(self, sid, df, invalid_data_behavior='warn'): """ Write the OHLCV data for the given sid. If there is no bcolz ctable yet created for the sid, create it. If the length of the bcolz ctable is not exactly to the date before the first day provided, fill the ctable with...
python
def write_sid(self, sid, df, invalid_data_behavior='warn'): """ Write the OHLCV data for the given sid. If there is no bcolz ctable yet created for the sid, create it. If the length of the bcolz ctable is not exactly to the date before the first day provided, fill the ctable with...
[ "def", "write_sid", "(", "self", ",", "sid", ",", "df", ",", "invalid_data_behavior", "=", "'warn'", ")", ":", "cols", "=", "{", "'open'", ":", "df", ".", "open", ".", "values", ",", "'high'", ":", "df", ".", "high", ".", "values", ",", "'low'", ":...
Write the OHLCV data for the given sid. If there is no bcolz ctable yet created for the sid, create it. If the length of the bcolz ctable is not exactly to the date before the first day provided, fill the ctable with 0s up to that date. Parameters ---------- sid : int ...
[ "Write", "the", "OHLCV", "data", "for", "the", "given", "sid", ".", "If", "there", "is", "no", "bcolz", "ctable", "yet", "created", "for", "the", "sid", "create", "it", ".", "If", "the", "length", "of", "the", "bcolz", "ctable", "is", "not", "exactly",...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L699-L730
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter.write_cols
def write_cols(self, sid, dts, cols, invalid_data_behavior='warn'): """ Write the OHLCV data for the given sid. If there is no bcolz ctable yet created for the sid, create it. If the length of the bcolz ctable is not exactly to the date before the first day provided, fill the cta...
python
def write_cols(self, sid, dts, cols, invalid_data_behavior='warn'): """ Write the OHLCV data for the given sid. If there is no bcolz ctable yet created for the sid, create it. If the length of the bcolz ctable is not exactly to the date before the first day provided, fill the cta...
[ "def", "write_cols", "(", "self", ",", "sid", ",", "dts", ",", "cols", ",", "invalid_data_behavior", "=", "'warn'", ")", ":", "if", "not", "all", "(", "len", "(", "dts", ")", "==", "len", "(", "cols", "[", "name", "]", ")", "for", "name", "in", "...
Write the OHLCV data for the given sid. If there is no bcolz ctable yet created for the sid, create it. If the length of the bcolz ctable is not exactly to the date before the first day provided, fill the ctable with 0s up to that date. Parameters ---------- sid : int ...
[ "Write", "the", "OHLCV", "data", "for", "the", "given", "sid", ".", "If", "there", "is", "no", "bcolz", "ctable", "yet", "created", "for", "the", "sid", "create", "it", ".", "If", "the", "length", "of", "the", "bcolz", "ctable", "is", "not", "exactly",...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L732-L760
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter._write_cols
def _write_cols(self, sid, dts, cols, invalid_data_behavior): """ Internal method for `write_cols` and `write`. Parameters ---------- sid : int The asset identifier for the data being written. dts : datetime64 array The dts corresponding to values...
python
def _write_cols(self, sid, dts, cols, invalid_data_behavior): """ Internal method for `write_cols` and `write`. Parameters ---------- sid : int The asset identifier for the data being written. dts : datetime64 array The dts corresponding to values...
[ "def", "_write_cols", "(", "self", ",", "sid", ",", "dts", ",", "cols", ",", "invalid_data_behavior", ")", ":", "table", "=", "self", ".", "_ensure_ctable", "(", "sid", ")", "tds", "=", "self", ".", "_session_labels", "input_first_day", "=", "self", ".", ...
Internal method for `write_cols` and `write`. Parameters ---------- sid : int The asset identifier for the data being written. dts : datetime64 array The dts corresponding to values in cols. cols : dict of str -> np.array dict of market data w...
[ "Internal", "method", "for", "write_cols", "and", "write", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L762-L844
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter.data_len_for_day
def data_len_for_day(self, day): """ Return the number of data points up to and including the provided day. """ day_ix = self._session_labels.get_loc(day) # Add one to the 0-indexed day_ix to get the number of days. num_days = day_ix + 1 return num_days * ...
python
def data_len_for_day(self, day): """ Return the number of data points up to and including the provided day. """ day_ix = self._session_labels.get_loc(day) # Add one to the 0-indexed day_ix to get the number of days. num_days = day_ix + 1 return num_days * ...
[ "def", "data_len_for_day", "(", "self", ",", "day", ")", ":", "day_ix", "=", "self", ".", "_session_labels", ".", "get_loc", "(", "day", ")", "# Add one to the 0-indexed day_ix to get the number of days.", "num_days", "=", "day_ix", "+", "1", "return", "num_days", ...
Return the number of data points up to and including the provided day.
[ "Return", "the", "number", "of", "data", "points", "up", "to", "and", "including", "the", "provided", "day", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L846-L854
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarWriter.truncate
def truncate(self, date): """Truncate data beyond this date in all ctables.""" truncate_slice_end = self.data_len_for_day(date) glob_path = os.path.join(self._rootdir, "*", "*", "*.bcolz") sid_paths = sorted(glob(glob_path)) for sid_path in sid_paths: file_name = os...
python
def truncate(self, date): """Truncate data beyond this date in all ctables.""" truncate_slice_end = self.data_len_for_day(date) glob_path = os.path.join(self._rootdir, "*", "*", "*.bcolz") sid_paths = sorted(glob(glob_path)) for sid_path in sid_paths: file_name = os...
[ "def", "truncate", "(", "self", ",", "date", ")", ":", "truncate_slice_end", "=", "self", ".", "data_len_for_day", "(", "date", ")", "glob_path", "=", "os", ".", "path", ".", "join", "(", "self", ".", "_rootdir", ",", "\"*\"", ",", "\"*\"", ",", "\"*.b...
Truncate data beyond this date in all ctables.
[ "Truncate", "data", "beyond", "this", "date", "in", "all", "ctables", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L856-L883
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarReader._minutes_to_exclude
def _minutes_to_exclude(self): """ Calculate the minutes which should be excluded when a window occurs on days which had an early close, i.e. days where the close based on the regular period of minutes per day and the market close do not match. Returns ------- ...
python
def _minutes_to_exclude(self): """ Calculate the minutes which should be excluded when a window occurs on days which had an early close, i.e. days where the close based on the regular period of minutes per day and the market close do not match. Returns ------- ...
[ "def", "_minutes_to_exclude", "(", "self", ")", ":", "market_opens", "=", "self", ".", "_market_opens", ".", "values", ".", "astype", "(", "'datetime64[m]'", ")", "market_closes", "=", "self", ".", "_market_closes", ".", "values", ".", "astype", "(", "'datetim...
Calculate the minutes which should be excluded when a window occurs on days which had an early close, i.e. days where the close based on the regular period of minutes per day and the market close do not match. Returns ------- List of DatetimeIndex representing the minute...
[ "Calculate", "the", "minutes", "which", "should", "be", "excluded", "when", "a", "window", "occurs", "on", "days", "which", "had", "an", "early", "close", "i", ".", "e", ".", "days", "where", "the", "close", "based", "on", "the", "regular", "period", "of...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L991-L1013
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarReader._minute_exclusion_tree
def _minute_exclusion_tree(self): """ Build an interval tree keyed by the start and end of each range of positions should be dropped from windows. (These are the minutes between an early close and the minute which would be the close based on the regular period if there were no ea...
python
def _minute_exclusion_tree(self): """ Build an interval tree keyed by the start and end of each range of positions should be dropped from windows. (These are the minutes between an early close and the minute which would be the close based on the regular period if there were no ea...
[ "def", "_minute_exclusion_tree", "(", "self", ")", ":", "itree", "=", "IntervalTree", "(", ")", "for", "market_open", ",", "early_close", "in", "self", ".", "_minutes_to_exclude", "(", ")", ":", "start_pos", "=", "self", ".", "_find_position_of_minute", "(", "...
Build an interval tree keyed by the start and end of each range of positions should be dropped from windows. (These are the minutes between an early close and the minute which would be the close based on the regular period if there were no early close.) The value of each node is the same...
[ "Build", "an", "interval", "tree", "keyed", "by", "the", "start", "and", "end", "of", "each", "range", "of", "positions", "should", "be", "dropped", "from", "windows", ".", "(", "These", "are", "the", "minutes", "between", "an", "early", "close", "and", ...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L1016-L1045
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarReader._exclusion_indices_for_range
def _exclusion_indices_for_range(self, start_idx, end_idx): """ Returns ------- List of tuples of (start, stop) which represent the ranges of minutes which should be excluded when a market minute window is requested. """ itree = self._minute_exclusion_tree ...
python
def _exclusion_indices_for_range(self, start_idx, end_idx): """ Returns ------- List of tuples of (start, stop) which represent the ranges of minutes which should be excluded when a market minute window is requested. """ itree = self._minute_exclusion_tree ...
[ "def", "_exclusion_indices_for_range", "(", "self", ",", "start_idx", ",", "end_idx", ")", ":", "itree", "=", "self", ".", "_minute_exclusion_tree", "if", "itree", ".", "overlaps", "(", "start_idx", ",", "end_idx", ")", ":", "ranges", "=", "[", "]", "interva...
Returns ------- List of tuples of (start, stop) which represent the ranges of minutes which should be excluded when a market minute window is requested.
[ "Returns", "-------", "List", "of", "tuples", "of", "(", "start", "stop", ")", "which", "represent", "the", "ranges", "of", "minutes", "which", "should", "be", "excluded", "when", "a", "market", "minute", "window", "is", "requested", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L1047-L1062
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarReader.get_value
def get_value(self, sid, dt, field): """ Retrieve the pricing info for the given sid, dt, and field. Parameters ---------- sid : int Asset identifier. dt : datetime-like The datetime at which the trade occurred. field : string ...
python
def get_value(self, sid, dt, field): """ Retrieve the pricing info for the given sid, dt, and field. Parameters ---------- sid : int Asset identifier. dt : datetime-like The datetime at which the trade occurred. field : string ...
[ "def", "get_value", "(", "self", ",", "sid", ",", "dt", ",", "field", ")", ":", "if", "self", ".", "_last_get_value_dt_value", "==", "dt", ".", "value", ":", "minute_pos", "=", "self", ".", "_last_get_value_dt_position", "else", ":", "try", ":", "minute_po...
Retrieve the pricing info for the given sid, dt, and field. Parameters ---------- sid : int Asset identifier. dt : datetime-like The datetime at which the trade occurred. field : string The type of pricing data to retrieve. ('open'...
[ "Retrieve", "the", "pricing", "info", "for", "the", "given", "sid", "dt", "and", "field", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L1098-L1149
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarReader._find_position_of_minute
def _find_position_of_minute(self, minute_dt): """ Internal method that returns the position of the given minute in the list of every trading minute since market open of the first trading day. Adjusts non market minutes to the last close. ex. this method would return 1 for 2002-...
python
def _find_position_of_minute(self, minute_dt): """ Internal method that returns the position of the given minute in the list of every trading minute since market open of the first trading day. Adjusts non market minutes to the last close. ex. this method would return 1 for 2002-...
[ "def", "_find_position_of_minute", "(", "self", ",", "minute_dt", ")", ":", "return", "find_position_of_minute", "(", "self", ".", "_market_open_values", ",", "self", ".", "_market_close_values", ",", "minute_dt", ".", "value", "/", "NANOS_IN_MINUTE", ",", "self", ...
Internal method that returns the position of the given minute in the list of every trading minute since market open of the first trading day. Adjusts non market minutes to the last close. ex. this method would return 1 for 2002-01-02 9:32 AM Eastern, if 2002-01-02 is the first trading d...
[ "Internal", "method", "that", "returns", "the", "position", "of", "the", "given", "minute", "in", "the", "list", "of", "every", "trading", "minute", "since", "market", "open", "of", "the", "first", "trading", "day", ".", "Adjusts", "non", "market", "minutes"...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L1203-L1228
train
quantopian/zipline
zipline/data/minute_bars.py
BcolzMinuteBarReader.load_raw_arrays
def load_raw_arrays(self, fields, start_dt, end_dt, sids): """ Parameters ---------- fields : list of str 'open', 'high', 'low', 'close', or 'volume' start_dt: Timestamp Beginning of the window range. end_dt: Timestamp End of the window ra...
python
def load_raw_arrays(self, fields, start_dt, end_dt, sids): """ Parameters ---------- fields : list of str 'open', 'high', 'low', 'close', or 'volume' start_dt: Timestamp Beginning of the window range. end_dt: Timestamp End of the window ra...
[ "def", "load_raw_arrays", "(", "self", ",", "fields", ",", "start_dt", ",", "end_dt", ",", "sids", ")", ":", "start_idx", "=", "self", ".", "_find_position_of_minute", "(", "start_dt", ")", "end_idx", "=", "self", ".", "_find_position_of_minute", "(", "end_dt"...
Parameters ---------- fields : list of str 'open', 'high', 'low', 'close', or 'volume' start_dt: Timestamp Beginning of the window range. end_dt: Timestamp End of the window range. sids : list of int The asset identifiers in the window....
[ "Parameters", "----------", "fields", ":", "list", "of", "str", "open", "high", "low", "close", "or", "volume", "start_dt", ":", "Timestamp", "Beginning", "of", "the", "window", "range", ".", "end_dt", ":", "Timestamp", "End", "of", "the", "window", "range",...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L1230-L1291
train
quantopian/zipline
zipline/data/minute_bars.py
H5MinuteBarUpdateWriter.write
def write(self, frames): """ Write the frames to the target HDF5 file, using the format used by ``pd.Panel.to_hdf`` Parameters ---------- frames : iter[(int, DataFrame)] or dict[int -> DataFrame] An iterable or other mapping of sid to the corresponding OHLCV ...
python
def write(self, frames): """ Write the frames to the target HDF5 file, using the format used by ``pd.Panel.to_hdf`` Parameters ---------- frames : iter[(int, DataFrame)] or dict[int -> DataFrame] An iterable or other mapping of sid to the corresponding OHLCV ...
[ "def", "write", "(", "self", ",", "frames", ")", ":", "with", "HDFStore", "(", "self", ".", "_path", ",", "'w'", ",", "complevel", "=", "self", ".", "_complevel", ",", "complib", "=", "self", ".", "_complib", ")", "as", "store", ":", "panel", "=", ...
Write the frames to the target HDF5 file, using the format used by ``pd.Panel.to_hdf`` Parameters ---------- frames : iter[(int, DataFrame)] or dict[int -> DataFrame] An iterable or other mapping of sid to the corresponding OHLCV pricing data.
[ "Write", "the", "frames", "to", "the", "target", "HDF5", "file", "using", "the", "format", "used", "by", "pd", ".", "Panel", ".", "to_hdf" ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/data/minute_bars.py#L1346-L1363
train
quantopian/zipline
zipline/pipeline/loaders/utils.py
next_event_indexer
def next_event_indexer(all_dates, data_query_cutoff, all_sids, event_dates, event_timestamps, event_sids): """ Construct an index array that, when applied to an array of values, produces a 2D a...
python
def next_event_indexer(all_dates, data_query_cutoff, all_sids, event_dates, event_timestamps, event_sids): """ Construct an index array that, when applied to an array of values, produces a 2D a...
[ "def", "next_event_indexer", "(", "all_dates", ",", "data_query_cutoff", ",", "all_sids", ",", "event_dates", ",", "event_timestamps", ",", "event_sids", ")", ":", "validate_event_metadata", "(", "event_dates", ",", "event_timestamps", ",", "event_sids", ")", "out", ...
Construct an index array that, when applied to an array of values, produces a 2D array containing the values associated with the next event for each sid at each moment in time. Locations where no next event was known will be filled with -1. Parameters ---------- all_dates : ndarray[datetime64[...
[ "Construct", "an", "index", "array", "that", "when", "applied", "to", "an", "array", "of", "values", "produces", "a", "2D", "array", "containing", "the", "values", "associated", "with", "the", "next", "event", "for", "each", "sid", "at", "each", "moment", ...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/utils.py#L25-L79
train
quantopian/zipline
zipline/pipeline/loaders/utils.py
previous_event_indexer
def previous_event_indexer(data_query_cutoff_times, all_sids, event_dates, event_timestamps, event_sids): """ Construct an index array that, when applied to an array of values, produces a 2D array con...
python
def previous_event_indexer(data_query_cutoff_times, all_sids, event_dates, event_timestamps, event_sids): """ Construct an index array that, when applied to an array of values, produces a 2D array con...
[ "def", "previous_event_indexer", "(", "data_query_cutoff_times", ",", "all_sids", ",", "event_dates", ",", "event_timestamps", ",", "event_sids", ")", ":", "validate_event_metadata", "(", "event_dates", ",", "event_timestamps", ",", "event_sids", ")", "out", "=", "np"...
Construct an index array that, when applied to an array of values, produces a 2D array containing the values associated with the previous event for each sid at each moment in time. Locations where no previous event was known will be filled with -1. Parameters ---------- data_query_cutoff : pd....
[ "Construct", "an", "index", "array", "that", "when", "applied", "to", "an", "array", "of", "values", "produces", "a", "2D", "array", "containing", "the", "values", "associated", "with", "the", "previous", "event", "for", "each", "sid", "at", "each", "moment"...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/utils.py#L82-L138
train
quantopian/zipline
zipline/pipeline/loaders/utils.py
last_in_date_group
def last_in_date_group(df, data_query_cutoff_times, assets, reindex=True, have_sids=True, extra_groupers=None): """ Determine the last piece of information known on each date in the date index...
python
def last_in_date_group(df, data_query_cutoff_times, assets, reindex=True, have_sids=True, extra_groupers=None): """ Determine the last piece of information known on each date in the date index...
[ "def", "last_in_date_group", "(", "df", ",", "data_query_cutoff_times", ",", "assets", ",", "reindex", "=", "True", ",", "have_sids", "=", "True", ",", "extra_groupers", "=", "None", ")", ":", "idx", "=", "[", "data_query_cutoff_times", "[", "data_query_cutoff_t...
Determine the last piece of information known on each date in the date index for each group. Input df MUST be sorted such that the correct last item is chosen from each group. Parameters ---------- df : pd.DataFrame The DataFrame containing the data to be grouped. Must be sorted so that ...
[ "Determine", "the", "last", "piece", "of", "information", "known", "on", "each", "date", "in", "the", "date" ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/utils.py#L141-L213
train
quantopian/zipline
zipline/pipeline/loaders/utils.py
ffill_across_cols
def ffill_across_cols(df, columns, name_map): """ Forward fill values in a DataFrame with special logic to handle cases that pd.DataFrame.ffill cannot and cast columns to appropriate types. Parameters ---------- df : pd.DataFrame The DataFrame to do forward-filling on. columns : lis...
python
def ffill_across_cols(df, columns, name_map): """ Forward fill values in a DataFrame with special logic to handle cases that pd.DataFrame.ffill cannot and cast columns to appropriate types. Parameters ---------- df : pd.DataFrame The DataFrame to do forward-filling on. columns : lis...
[ "def", "ffill_across_cols", "(", "df", ",", "columns", ",", "name_map", ")", ":", "df", ".", "ffill", "(", "inplace", "=", "True", ")", "# Fill in missing values specified by each column. This is made", "# significantly more complex by the fact that we need to work around", "...
Forward fill values in a DataFrame with special logic to handle cases that pd.DataFrame.ffill cannot and cast columns to appropriate types. Parameters ---------- df : pd.DataFrame The DataFrame to do forward-filling on. columns : list of BoundColumn The BoundColumns that correspond ...
[ "Forward", "fill", "values", "in", "a", "DataFrame", "with", "special", "logic", "to", "handle", "cases", "that", "pd", ".", "DataFrame", ".", "ffill", "cannot", "and", "cast", "columns", "to", "appropriate", "types", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/utils.py#L216-L264
train
quantopian/zipline
zipline/pipeline/loaders/utils.py
shift_dates
def shift_dates(dates, start_date, end_date, shift): """ Shift dates of a pipeline query back by `shift` days. load_adjusted_array is called with dates on which the user's algo will be shown data, which means we need to return the data that would be known at the start of each date. This is often l...
python
def shift_dates(dates, start_date, end_date, shift): """ Shift dates of a pipeline query back by `shift` days. load_adjusted_array is called with dates on which the user's algo will be shown data, which means we need to return the data that would be known at the start of each date. This is often l...
[ "def", "shift_dates", "(", "dates", ",", "start_date", ",", "end_date", ",", "shift", ")", ":", "try", ":", "start", "=", "dates", ".", "get_loc", "(", "start_date", ")", "except", "KeyError", ":", "if", "start_date", "<", "dates", "[", "0", "]", ":", ...
Shift dates of a pipeline query back by `shift` days. load_adjusted_array is called with dates on which the user's algo will be shown data, which means we need to return the data that would be known at the start of each date. This is often labeled with a previous date in the underlying data (e.g. at t...
[ "Shift", "dates", "of", "a", "pipeline", "query", "back", "by", "shift", "days", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/utils.py#L267-L330
train
quantopian/zipline
zipline/utils/sharedoc.py
format_docstring
def format_docstring(owner_name, docstring, formatters): """ Template ``formatters`` into ``docstring``. Parameters ---------- owner_name : str The name of the function or class whose docstring is being templated. Only used for error messages. docstring : str The docstri...
python
def format_docstring(owner_name, docstring, formatters): """ Template ``formatters`` into ``docstring``. Parameters ---------- owner_name : str The name of the function or class whose docstring is being templated. Only used for error messages. docstring : str The docstri...
[ "def", "format_docstring", "(", "owner_name", ",", "docstring", ",", "formatters", ")", ":", "# Build a dict of parameters to a vanilla format() call by searching for", "# each entry in **formatters and applying any leading whitespace to each", "# line in the desired substitution.", "forma...
Template ``formatters`` into ``docstring``. Parameters ---------- owner_name : str The name of the function or class whose docstring is being templated. Only used for error messages. docstring : str The docstring to template. formatters : dict[str -> str] Parameters ...
[ "Template", "formatters", "into", "docstring", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/utils/sharedoc.py#L35-L82
train
quantopian/zipline
zipline/utils/sharedoc.py
templated_docstring
def templated_docstring(**docs): """ Decorator allowing the use of templated docstrings. Examples -------- >>> @templated_docstring(foo='bar') ... def my_func(self, foo): ... '''{foo}''' ... >>> my_func.__doc__ 'bar' """ def decorator(f): f.__doc__ = format_d...
python
def templated_docstring(**docs): """ Decorator allowing the use of templated docstrings. Examples -------- >>> @templated_docstring(foo='bar') ... def my_func(self, foo): ... '''{foo}''' ... >>> my_func.__doc__ 'bar' """ def decorator(f): f.__doc__ = format_d...
[ "def", "templated_docstring", "(", "*", "*", "docs", ")", ":", "def", "decorator", "(", "f", ")", ":", "f", ".", "__doc__", "=", "format_docstring", "(", "f", ".", "__name__", ",", "f", ".", "__doc__", ",", "docs", ")", "return", "f", "return", "deco...
Decorator allowing the use of templated docstrings. Examples -------- >>> @templated_docstring(foo='bar') ... def my_func(self, foo): ... '''{foo}''' ... >>> my_func.__doc__ 'bar'
[ "Decorator", "allowing", "the", "use", "of", "templated", "docstrings", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/utils/sharedoc.py#L85-L101
train
quantopian/zipline
zipline/pipeline/pipeline.py
Pipeline.add
def add(self, term, name, overwrite=False): """ Add a column. The results of computing `term` will show up as a column in the DataFrame produced by running this pipeline. Parameters ---------- column : zipline.pipeline.Term A Filter, Factor, or Class...
python
def add(self, term, name, overwrite=False): """ Add a column. The results of computing `term` will show up as a column in the DataFrame produced by running this pipeline. Parameters ---------- column : zipline.pipeline.Term A Filter, Factor, or Class...
[ "def", "add", "(", "self", ",", "term", ",", "name", ",", "overwrite", "=", "False", ")", ":", "self", ".", "validate_column", "(", "name", ",", "term", ")", "columns", "=", "self", ".", "columns", "if", "name", "in", "columns", ":", "if", "overwrite...
Add a column. The results of computing `term` will show up as a column in the DataFrame produced by running this pipeline. Parameters ---------- column : zipline.pipeline.Term A Filter, Factor, or Classifier to add to the pipeline. name : str Nam...
[ "Add", "a", "column", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/pipeline.py#L80-L112
train
quantopian/zipline
zipline/pipeline/pipeline.py
Pipeline.set_screen
def set_screen(self, screen, overwrite=False): """ Set a screen on this Pipeline. Parameters ---------- filter : zipline.pipeline.Filter The filter to apply as a screen. overwrite : bool Whether to overwrite any existing screen. If overwrite is F...
python
def set_screen(self, screen, overwrite=False): """ Set a screen on this Pipeline. Parameters ---------- filter : zipline.pipeline.Filter The filter to apply as a screen. overwrite : bool Whether to overwrite any existing screen. If overwrite is F...
[ "def", "set_screen", "(", "self", ",", "screen", ",", "overwrite", "=", "False", ")", ":", "if", "self", ".", "_screen", "is", "not", "None", "and", "not", "overwrite", ":", "raise", "ValueError", "(", "\"set_screen() called with overwrite=False and screen already...
Set a screen on this Pipeline. Parameters ---------- filter : zipline.pipeline.Filter The filter to apply as a screen. overwrite : bool Whether to overwrite any existing screen. If overwrite is False and self.screen is not None, we raise an error.
[ "Set", "a", "screen", "on", "this", "Pipeline", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/pipeline.py#L137-L158
train
quantopian/zipline
zipline/pipeline/pipeline.py
Pipeline.to_execution_plan
def to_execution_plan(self, domain, default_screen, start_date, end_date): """ Compile into an ExecutionPlan. Parameters ---------- domain : zipline.pipeline.domain.Domain ...
python
def to_execution_plan(self, domain, default_screen, start_date, end_date): """ Compile into an ExecutionPlan. Parameters ---------- domain : zipline.pipeline.domain.Domain ...
[ "def", "to_execution_plan", "(", "self", ",", "domain", ",", "default_screen", ",", "start_date", ",", "end_date", ")", ":", "if", "self", ".", "_domain", "is", "not", "GENERIC", "and", "self", ".", "_domain", "is", "not", "domain", ":", "raise", "Assertio...
Compile into an ExecutionPlan. Parameters ---------- domain : zipline.pipeline.domain.Domain Domain on which the pipeline will be executed. default_screen : zipline.pipeline.term.Term Term to use as a screen if self.screen is None. all_dates : pd.Datetime...
[ "Compile", "into", "an", "ExecutionPlan", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/pipeline.py#L160-L199
train
quantopian/zipline
zipline/pipeline/pipeline.py
Pipeline._prepare_graph_terms
def _prepare_graph_terms(self, default_screen): """Helper for to_graph and to_execution_plan.""" columns = self.columns.copy() screen = self.screen if screen is None: screen = default_screen columns[SCREEN_NAME] = screen return columns
python
def _prepare_graph_terms(self, default_screen): """Helper for to_graph and to_execution_plan.""" columns = self.columns.copy() screen = self.screen if screen is None: screen = default_screen columns[SCREEN_NAME] = screen return columns
[ "def", "_prepare_graph_terms", "(", "self", ",", "default_screen", ")", ":", "columns", "=", "self", ".", "columns", ".", "copy", "(", ")", "screen", "=", "self", ".", "screen", "if", "screen", "is", "None", ":", "screen", "=", "default_screen", "columns",...
Helper for to_graph and to_execution_plan.
[ "Helper", "for", "to_graph", "and", "to_execution_plan", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/pipeline.py#L217-L224
train
quantopian/zipline
zipline/pipeline/pipeline.py
Pipeline.show_graph
def show_graph(self, format='svg'): """ Render this Pipeline as a DAG. Parameters ---------- format : {'svg', 'png', 'jpeg'} Image format to render with. Default is 'svg'. """ g = self.to_simple_graph(AssetExists()) if format == 'svg': ...
python
def show_graph(self, format='svg'): """ Render this Pipeline as a DAG. Parameters ---------- format : {'svg', 'png', 'jpeg'} Image format to render with. Default is 'svg'. """ g = self.to_simple_graph(AssetExists()) if format == 'svg': ...
[ "def", "show_graph", "(", "self", ",", "format", "=", "'svg'", ")", ":", "g", "=", "self", ".", "to_simple_graph", "(", "AssetExists", "(", ")", ")", "if", "format", "==", "'svg'", ":", "return", "g", ".", "svg", "elif", "format", "==", "'png'", ":",...
Render this Pipeline as a DAG. Parameters ---------- format : {'svg', 'png', 'jpeg'} Image format to render with. Default is 'svg'.
[ "Render", "this", "Pipeline", "as", "a", "DAG", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/pipeline.py#L227-L246
train
quantopian/zipline
zipline/pipeline/pipeline.py
Pipeline._output_terms
def _output_terms(self): """ A list of terms that are outputs of this pipeline. Includes all terms registered as data outputs of the pipeline, plus the screen, if present. """ terms = list(six.itervalues(self._columns)) screen = self.screen if screen is n...
python
def _output_terms(self): """ A list of terms that are outputs of this pipeline. Includes all terms registered as data outputs of the pipeline, plus the screen, if present. """ terms = list(six.itervalues(self._columns)) screen = self.screen if screen is n...
[ "def", "_output_terms", "(", "self", ")", ":", "terms", "=", "list", "(", "six", ".", "itervalues", "(", "self", ".", "_columns", ")", ")", "screen", "=", "self", ".", "screen", "if", "screen", "is", "not", "None", ":", "terms", ".", "append", "(", ...
A list of terms that are outputs of this pipeline. Includes all terms registered as data outputs of the pipeline, plus the screen, if present.
[ "A", "list", "of", "terms", "that", "are", "outputs", "of", "this", "pipeline", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/pipeline.py#L255-L266
train
quantopian/zipline
zipline/pipeline/pipeline.py
Pipeline.domain
def domain(self, default): """ Get the domain for this pipeline. - If an explicit domain was provided at construction time, use it. - Otherwise, infer a domain from the registered columns. - If no domain can be inferred, return ``default``. Parameters ----------...
python
def domain(self, default): """ Get the domain for this pipeline. - If an explicit domain was provided at construction time, use it. - Otherwise, infer a domain from the registered columns. - If no domain can be inferred, return ``default``. Parameters ----------...
[ "def", "domain", "(", "self", ",", "default", ")", ":", "# Always compute our inferred domain to ensure that it's compatible", "# with our explicit domain.", "inferred", "=", "infer_domain", "(", "self", ".", "_output_terms", ")", "if", "inferred", "is", "GENERIC", "and",...
Get the domain for this pipeline. - If an explicit domain was provided at construction time, use it. - Otherwise, infer a domain from the registered columns. - If no domain can be inferred, return ``default``. Parameters ---------- default : zipline.pipeline.Domain ...
[ "Get", "the", "domain", "for", "this", "pipeline", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/pipeline.py#L269-L314
train
quantopian/zipline
zipline/pipeline/expression.py
_ensure_element
def _ensure_element(tup, elem): """ Create a tuple containing all elements of tup, plus elem. Returns the new tuple and the index of elem in the new tuple. """ try: return tup, tup.index(elem) except ValueError: return tuple(chain(tup, (elem,))), len(tup)
python
def _ensure_element(tup, elem): """ Create a tuple containing all elements of tup, plus elem. Returns the new tuple and the index of elem in the new tuple. """ try: return tup, tup.index(elem) except ValueError: return tuple(chain(tup, (elem,))), len(tup)
[ "def", "_ensure_element", "(", "tup", ",", "elem", ")", ":", "try", ":", "return", "tup", ",", "tup", ".", "index", "(", "elem", ")", "except", "ValueError", ":", "return", "tuple", "(", "chain", "(", "tup", ",", "(", "elem", ",", ")", ")", ")", ...
Create a tuple containing all elements of tup, plus elem. Returns the new tuple and the index of elem in the new tuple.
[ "Create", "a", "tuple", "containing", "all", "elements", "of", "tup", "plus", "elem", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/expression.py#L92-L101
train
quantopian/zipline
zipline/pipeline/expression.py
NumericalExpression._validate
def _validate(self): """ Ensure that our expression string has variables of the form x_0, x_1, ... x_(N - 1), where N is the length of our inputs. """ variable_names, _unused = getExprNames(self._expr, {}) expr_indices = [] for name in variable_names: ...
python
def _validate(self): """ Ensure that our expression string has variables of the form x_0, x_1, ... x_(N - 1), where N is the length of our inputs. """ variable_names, _unused = getExprNames(self._expr, {}) expr_indices = [] for name in variable_names: ...
[ "def", "_validate", "(", "self", ")", ":", "variable_names", ",", "_unused", "=", "getExprNames", "(", "self", ".", "_expr", ",", "{", "}", ")", "expr_indices", "=", "[", "]", "for", "name", "in", "variable_names", ":", "if", "name", "==", "'inf'", ":"...
Ensure that our expression string has variables of the form x_0, x_1, ... x_(N - 1), where N is the length of our inputs.
[ "Ensure", "that", "our", "expression", "string", "has", "variables", "of", "the", "form", "x_0", "x_1", "...", "x_", "(", "N", "-", "1", ")", "where", "N", "is", "the", "length", "of", "our", "inputs", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/expression.py#L213-L236
train
quantopian/zipline
zipline/pipeline/expression.py
NumericalExpression._compute
def _compute(self, arrays, dates, assets, mask): """ Compute our stored expression string with numexpr. """ out = full(mask.shape, self.missing_value, dtype=self.dtype) # This writes directly into our output buffer. numexpr.evaluate( self._expr, lo...
python
def _compute(self, arrays, dates, assets, mask): """ Compute our stored expression string with numexpr. """ out = full(mask.shape, self.missing_value, dtype=self.dtype) # This writes directly into our output buffer. numexpr.evaluate( self._expr, lo...
[ "def", "_compute", "(", "self", ",", "arrays", ",", "dates", ",", "assets", ",", "mask", ")", ":", "out", "=", "full", "(", "mask", ".", "shape", ",", "self", ".", "missing_value", ",", "dtype", "=", "self", ".", "dtype", ")", "# This writes directly i...
Compute our stored expression string with numexpr.
[ "Compute", "our", "stored", "expression", "string", "with", "numexpr", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/expression.py#L238-L253
train
quantopian/zipline
zipline/pipeline/expression.py
NumericalExpression._rebind_variables
def _rebind_variables(self, new_inputs): """ Return self._expr with all variables rebound to the indices implied by new_inputs. """ expr = self._expr # If we have 11+ variables, some of our variable names may be # substrings of other variable names. For example, ...
python
def _rebind_variables(self, new_inputs): """ Return self._expr with all variables rebound to the indices implied by new_inputs. """ expr = self._expr # If we have 11+ variables, some of our variable names may be # substrings of other variable names. For example, ...
[ "def", "_rebind_variables", "(", "self", ",", "new_inputs", ")", ":", "expr", "=", "self", ".", "_expr", "# If we have 11+ variables, some of our variable names may be", "# substrings of other variable names. For example, we might have x_1,", "# x_10, and x_100. By enumerating in rever...
Return self._expr with all variables rebound to the indices implied by new_inputs.
[ "Return", "self", ".", "_expr", "with", "all", "variables", "rebound", "to", "the", "indices", "implied", "by", "new_inputs", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/expression.py#L255-L279
train
quantopian/zipline
zipline/pipeline/expression.py
NumericalExpression._merge_expressions
def _merge_expressions(self, other): """ Merge the inputs of two NumericalExpressions into a single input tuple, rewriting their respective string expressions to make input names resolve correctly. Returns a tuple of (new_self_expr, new_other_expr, new_inputs) """ ...
python
def _merge_expressions(self, other): """ Merge the inputs of two NumericalExpressions into a single input tuple, rewriting their respective string expressions to make input names resolve correctly. Returns a tuple of (new_self_expr, new_other_expr, new_inputs) """ ...
[ "def", "_merge_expressions", "(", "self", ",", "other", ")", ":", "new_inputs", "=", "tuple", "(", "set", "(", "self", ".", "inputs", ")", ".", "union", "(", "other", ".", "inputs", ")", ")", "new_self_expr", "=", "self", ".", "_rebind_variables", "(", ...
Merge the inputs of two NumericalExpressions into a single input tuple, rewriting their respective string expressions to make input names resolve correctly. Returns a tuple of (new_self_expr, new_other_expr, new_inputs)
[ "Merge", "the", "inputs", "of", "two", "NumericalExpressions", "into", "a", "single", "input", "tuple", "rewriting", "their", "respective", "string", "expressions", "to", "make", "input", "names", "resolve", "correctly", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/expression.py#L281-L292
train
quantopian/zipline
zipline/pipeline/expression.py
NumericalExpression.build_binary_op
def build_binary_op(self, op, other): """ Compute new expression strings and a new inputs tuple for combining self and other with a binary operator. """ if isinstance(other, NumericalExpression): self_expr, other_expr, new_inputs = self._merge_expressions(other) ...
python
def build_binary_op(self, op, other): """ Compute new expression strings and a new inputs tuple for combining self and other with a binary operator. """ if isinstance(other, NumericalExpression): self_expr, other_expr, new_inputs = self._merge_expressions(other) ...
[ "def", "build_binary_op", "(", "self", ",", "op", ",", "other", ")", ":", "if", "isinstance", "(", "other", ",", "NumericalExpression", ")", ":", "self_expr", ",", "other_expr", ",", "new_inputs", "=", "self", ".", "_merge_expressions", "(", "other", ")", ...
Compute new expression strings and a new inputs tuple for combining self and other with a binary operator.
[ "Compute", "new", "expression", "strings", "and", "a", "new", "inputs", "tuple", "for", "combining", "self", "and", "other", "with", "a", "binary", "operator", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/expression.py#L294-L311
train
quantopian/zipline
zipline/pipeline/expression.py
NumericalExpression.graph_repr
def graph_repr(self): """Short repr to use when rendering Pipeline graphs.""" # Replace any floating point numbers in the expression # with their scientific notation final = re.sub(r"[-+]?\d*\.\d+", lambda x: format(float(x.group(0)), '.2E'), ...
python
def graph_repr(self): """Short repr to use when rendering Pipeline graphs.""" # Replace any floating point numbers in the expression # with their scientific notation final = re.sub(r"[-+]?\d*\.\d+", lambda x: format(float(x.group(0)), '.2E'), ...
[ "def", "graph_repr", "(", "self", ")", ":", "# Replace any floating point numbers in the expression", "# with their scientific notation", "final", "=", "re", ".", "sub", "(", "r\"[-+]?\\d*\\.\\d+\"", ",", "lambda", "x", ":", "format", "(", "float", "(", "x", ".", "g...
Short repr to use when rendering Pipeline graphs.
[ "Short", "repr", "to", "use", "when", "rendering", "Pipeline", "graphs", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/expression.py#L327-L338
train
quantopian/zipline
zipline/utils/paths.py
last_modified_time
def last_modified_time(path): """ Get the last modified time of path as a Timestamp. """ return pd.Timestamp(os.path.getmtime(path), unit='s', tz='UTC')
python
def last_modified_time(path): """ Get the last modified time of path as a Timestamp. """ return pd.Timestamp(os.path.getmtime(path), unit='s', tz='UTC')
[ "def", "last_modified_time", "(", "path", ")", ":", "return", "pd", ".", "Timestamp", "(", "os", ".", "path", ".", "getmtime", "(", "path", ")", ",", "unit", "=", "'s'", ",", "tz", "=", "'UTC'", ")" ]
Get the last modified time of path as a Timestamp.
[ "Get", "the", "last", "modified", "time", "of", "path", "as", "a", "Timestamp", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/utils/paths.py#L78-L82
train
quantopian/zipline
zipline/utils/paths.py
zipline_root
def zipline_root(environ=None): """ Get the root directory for all zipline-managed files. For testing purposes, this accepts a dictionary to interpret as the os environment. Parameters ---------- environ : dict, optional A dict to interpret as the os environment. Returns -...
python
def zipline_root(environ=None): """ Get the root directory for all zipline-managed files. For testing purposes, this accepts a dictionary to interpret as the os environment. Parameters ---------- environ : dict, optional A dict to interpret as the os environment. Returns -...
[ "def", "zipline_root", "(", "environ", "=", "None", ")", ":", "if", "environ", "is", "None", ":", "environ", "=", "os", ".", "environ", "root", "=", "environ", ".", "get", "(", "'ZIPLINE_ROOT'", ",", "None", ")", "if", "root", "is", "None", ":", "roo...
Get the root directory for all zipline-managed files. For testing purposes, this accepts a dictionary to interpret as the os environment. Parameters ---------- environ : dict, optional A dict to interpret as the os environment. Returns ------- root : string Path to the...
[ "Get", "the", "root", "directory", "for", "all", "zipline", "-", "managed", "files", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/utils/paths.py#L107-L131
train
quantopian/zipline
zipline/pipeline/loaders/frame.py
DataFrameLoader.format_adjustments
def format_adjustments(self, dates, assets): """ Build a dict of Adjustment objects in the format expected by AdjustedArray. Returns a dict of the form: { # Integer index into `dates` for the date on which we should # apply the list of adjustments. ...
python
def format_adjustments(self, dates, assets): """ Build a dict of Adjustment objects in the format expected by AdjustedArray. Returns a dict of the form: { # Integer index into `dates` for the date on which we should # apply the list of adjustments. ...
[ "def", "format_adjustments", "(", "self", ",", "dates", ",", "assets", ")", ":", "make_adjustment", "=", "partial", "(", "make_adjustment_from_labels", ",", "dates", ",", "assets", ")", "min_date", ",", "max_date", "=", "dates", "[", "[", "0", ",", "-", "1...
Build a dict of Adjustment objects in the format expected by AdjustedArray. Returns a dict of the form: { # Integer index into `dates` for the date on which we should # apply the list of adjustments. 1 : [ Float64Multiply(first_row=2, last_row...
[ "Build", "a", "dict", "of", "Adjustment", "objects", "in", "the", "format", "expected", "by", "AdjustedArray", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/frame.py#L83-L147
train
quantopian/zipline
zipline/pipeline/loaders/frame.py
DataFrameLoader.load_adjusted_array
def load_adjusted_array(self, domain, columns, dates, sids, mask): """ Load data from our stored baseline. """ if len(columns) != 1: raise ValueError( "Can't load multiple columns with DataFrameLoader" ) column = columns[0] self._v...
python
def load_adjusted_array(self, domain, columns, dates, sids, mask): """ Load data from our stored baseline. """ if len(columns) != 1: raise ValueError( "Can't load multiple columns with DataFrameLoader" ) column = columns[0] self._v...
[ "def", "load_adjusted_array", "(", "self", ",", "domain", ",", "columns", ",", "dates", ",", "sids", ",", "mask", ")", ":", "if", "len", "(", "columns", ")", "!=", "1", ":", "raise", "ValueError", "(", "\"Can't load multiple columns with DataFrameLoader\"", ")...
Load data from our stored baseline.
[ "Load", "data", "from", "our", "stored", "baseline", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/frame.py#L149-L181
train
quantopian/zipline
zipline/pipeline/loaders/frame.py
DataFrameLoader._validate_input_column
def _validate_input_column(self, column): """Make sure a passed column is our column. """ if column != self.column and column.unspecialize() != self.column: raise ValueError("Can't load unknown column %s" % column)
python
def _validate_input_column(self, column): """Make sure a passed column is our column. """ if column != self.column and column.unspecialize() != self.column: raise ValueError("Can't load unknown column %s" % column)
[ "def", "_validate_input_column", "(", "self", ",", "column", ")", ":", "if", "column", "!=", "self", ".", "column", "and", "column", ".", "unspecialize", "(", ")", "!=", "self", ".", "column", ":", "raise", "ValueError", "(", "\"Can't load unknown column %s\""...
Make sure a passed column is our column.
[ "Make", "sure", "a", "passed", "column", "is", "our", "column", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/frame.py#L183-L187
train
quantopian/zipline
zipline/utils/security_list.py
load_from_directory
def load_from_directory(list_name): """ To resolve the symbol in the LEVERAGED_ETF list, the date on which the symbol was in effect is needed. Furthermore, to maintain a point in time record of our own maintenance of the restricted list, we need a knowledge date. Thus, restricted lists are dict...
python
def load_from_directory(list_name): """ To resolve the symbol in the LEVERAGED_ETF list, the date on which the symbol was in effect is needed. Furthermore, to maintain a point in time record of our own maintenance of the restricted list, we need a knowledge date. Thus, restricted lists are dict...
[ "def", "load_from_directory", "(", "list_name", ")", ":", "data", "=", "{", "}", "dir_path", "=", "os", ".", "path", ".", "join", "(", "SECURITY_LISTS_DIR", ",", "list_name", ")", "for", "kd_name", "in", "listdir", "(", "dir_path", ")", ":", "kd", "=", ...
To resolve the symbol in the LEVERAGED_ETF list, the date on which the symbol was in effect is needed. Furthermore, to maintain a point in time record of our own maintenance of the restricted list, we need a knowledge date. Thus, restricted lists are dictionaries of datetime->symbol lists. new symb...
[ "To", "resolve", "the", "symbol", "in", "the", "LEVERAGED_ETF", "list", "the", "date", "on", "which", "the", "symbol", "was", "in", "effect", "is", "needed", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/utils/security_list.py#L123-L159
train
quantopian/zipline
zipline/utils/memoize.py
_weak_lru_cache
def _weak_lru_cache(maxsize=100): """ Users should only access the lru_cache through its public API: cache_info, cache_clear The internals of the lru_cache are encapsulated for thread safety and to allow the implementation to change. """ def decorating_function( user_function, tu...
python
def _weak_lru_cache(maxsize=100): """ Users should only access the lru_cache through its public API: cache_info, cache_clear The internals of the lru_cache are encapsulated for thread safety and to allow the implementation to change. """ def decorating_function( user_function, tu...
[ "def", "_weak_lru_cache", "(", "maxsize", "=", "100", ")", ":", "def", "decorating_function", "(", "user_function", ",", "tuple", "=", "tuple", ",", "sorted", "=", "sorted", ",", "len", "=", "len", ",", "KeyError", "=", "KeyError", ")", ":", "hits", ",",...
Users should only access the lru_cache through its public API: cache_info, cache_clear The internals of the lru_cache are encapsulated for thread safety and to allow the implementation to change.
[ "Users", "should", "only", "access", "the", "lru_cache", "through", "its", "public", "API", ":", "cache_info", "cache_clear", "The", "internals", "of", "the", "lru_cache", "are", "encapsulated", "for", "thread", "safety", "and", "to", "allow", "the", "implementa...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/utils/memoize.py#L44-L120
train
quantopian/zipline
zipline/utils/memoize.py
weak_lru_cache
def weak_lru_cache(maxsize=100): """Weak least-recently-used cache decorator. If *maxsize* is set to None, the LRU features are disabled and the cache can grow without bound. Arguments to the cached function must be hashable. Any that are weak- referenceable will be stored by weak reference. Once...
python
def weak_lru_cache(maxsize=100): """Weak least-recently-used cache decorator. If *maxsize* is set to None, the LRU features are disabled and the cache can grow without bound. Arguments to the cached function must be hashable. Any that are weak- referenceable will be stored by weak reference. Once...
[ "def", "weak_lru_cache", "(", "maxsize", "=", "100", ")", ":", "class", "desc", "(", "lazyval", ")", ":", "def", "__get__", "(", "self", ",", "instance", ",", "owner", ")", ":", "if", "instance", "is", "None", ":", "return", "self", "try", ":", "retu...
Weak least-recently-used cache decorator. If *maxsize* is set to None, the LRU features are disabled and the cache can grow without bound. Arguments to the cached function must be hashable. Any that are weak- referenceable will be stored by weak reference. Once any of the args have been garbage c...
[ "Weak", "least", "-", "recently", "-", "used", "cache", "decorator", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/utils/memoize.py#L211-L248
train
quantopian/zipline
zipline/utils/final.py
is_final
def is_final(name, mro): """ Checks if `name` is a `final` object in the given `mro`. We need to check the mro because we need to directly go into the __dict__ of the classes. Because `final` objects are descriptor, we need to grab them _BEFORE_ the `__call__` is invoked. """ return any(isin...
python
def is_final(name, mro): """ Checks if `name` is a `final` object in the given `mro`. We need to check the mro because we need to directly go into the __dict__ of the classes. Because `final` objects are descriptor, we need to grab them _BEFORE_ the `__call__` is invoked. """ return any(isin...
[ "def", "is_final", "(", "name", ",", "mro", ")", ":", "return", "any", "(", "isinstance", "(", "getattr", "(", "c", ",", "'__dict__'", ",", "{", "}", ")", ".", "get", "(", "name", ")", ",", "final", ")", "for", "c", "in", "bases_mro", "(", "mro",...
Checks if `name` is a `final` object in the given `mro`. We need to check the mro because we need to directly go into the __dict__ of the classes. Because `final` objects are descriptor, we need to grab them _BEFORE_ the `__call__` is invoked.
[ "Checks", "if", "name", "is", "a", "final", "object", "in", "the", "given", "mro", ".", "We", "need", "to", "check", "the", "mro", "because", "we", "need", "to", "directly", "go", "into", "the", "__dict__", "of", "the", "classes", ".", "Because", "fina...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/utils/final.py#L20-L28
train
quantopian/zipline
zipline/pipeline/data/dataset.py
Column.bind
def bind(self, name): """ Bind a `Column` object to its name. """ return _BoundColumnDescr( dtype=self.dtype, missing_value=self.missing_value, name=name, doc=self.doc, metadata=self.metadata, )
python
def bind(self, name): """ Bind a `Column` object to its name. """ return _BoundColumnDescr( dtype=self.dtype, missing_value=self.missing_value, name=name, doc=self.doc, metadata=self.metadata, )
[ "def", "bind", "(", "self", ",", "name", ")", ":", "return", "_BoundColumnDescr", "(", "dtype", "=", "self", ".", "dtype", ",", "missing_value", "=", "self", ".", "missing_value", ",", "name", "=", "name", ",", "doc", "=", "self", ".", "doc", ",", "m...
Bind a `Column` object to its name.
[ "Bind", "a", "Column", "object", "to", "its", "name", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/data/dataset.py#L49-L59
train
quantopian/zipline
zipline/pipeline/data/dataset.py
BoundColumn.specialize
def specialize(self, domain): """Specialize ``self`` to a concrete domain. """ if domain == self.domain: return self return type(self)( dtype=self.dtype, missing_value=self.missing_value, dataset=self._dataset.specialize(domain), ...
python
def specialize(self, domain): """Specialize ``self`` to a concrete domain. """ if domain == self.domain: return self return type(self)( dtype=self.dtype, missing_value=self.missing_value, dataset=self._dataset.specialize(domain), ...
[ "def", "specialize", "(", "self", ",", "domain", ")", ":", "if", "domain", "==", "self", ".", "domain", ":", "return", "self", "return", "type", "(", "self", ")", "(", "dtype", "=", "self", ".", "dtype", ",", "missing_value", "=", "self", ".", "missi...
Specialize ``self`` to a concrete domain.
[ "Specialize", "self", "to", "a", "concrete", "domain", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/data/dataset.py#L177-L190
train
quantopian/zipline
zipline/pipeline/data/dataset.py
DataSet.get_column
def get_column(cls, name): """Look up a column by name. Parameters ---------- name : str Name of the column to look up. Returns ------- column : zipline.pipeline.data.BoundColumn Column with the given name. Raises ------ ...
python
def get_column(cls, name): """Look up a column by name. Parameters ---------- name : str Name of the column to look up. Returns ------- column : zipline.pipeline.data.BoundColumn Column with the given name. Raises ------ ...
[ "def", "get_column", "(", "cls", ",", "name", ")", ":", "clsdict", "=", "vars", "(", "cls", ")", "try", ":", "maybe_column", "=", "clsdict", "[", "name", "]", "if", "not", "isinstance", "(", "maybe_column", ",", "_BoundColumnDescr", ")", ":", "raise", ...
Look up a column by name. Parameters ---------- name : str Name of the column to look up. Returns ------- column : zipline.pipeline.data.BoundColumn Column with the given name. Raises ------ AttributeError If ...
[ "Look", "up", "a", "column", "by", "name", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/data/dataset.py#L502-L540
train
quantopian/zipline
zipline/pipeline/data/dataset.py
DataSetFamily._make_dataset
def _make_dataset(cls, coords): """Construct a new dataset given the coordinates. """ class Slice(cls._SliceType): extra_coords = coords Slice.__name__ = '%s.slice(%s)' % ( cls.__name__, ', '.join('%s=%r' % item for item in coords.items()), ) ...
python
def _make_dataset(cls, coords): """Construct a new dataset given the coordinates. """ class Slice(cls._SliceType): extra_coords = coords Slice.__name__ = '%s.slice(%s)' % ( cls.__name__, ', '.join('%s=%r' % item for item in coords.items()), ) ...
[ "def", "_make_dataset", "(", "cls", ",", "coords", ")", ":", "class", "Slice", "(", "cls", ".", "_SliceType", ")", ":", "extra_coords", "=", "coords", "Slice", ".", "__name__", "=", "'%s.slice(%s)'", "%", "(", "cls", ".", "__name__", ",", "', '", ".", ...
Construct a new dataset given the coordinates.
[ "Construct", "a", "new", "dataset", "given", "the", "coordinates", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/data/dataset.py#L813-L823
train
quantopian/zipline
zipline/pipeline/data/dataset.py
DataSetFamily.slice
def slice(cls, *args, **kwargs): """Take a slice of a DataSetFamily to produce a dataset indexed by asset and date. Parameters ---------- *args **kwargs The coordinates to fix along each extra dimension. Returns ------- dataset : Data...
python
def slice(cls, *args, **kwargs): """Take a slice of a DataSetFamily to produce a dataset indexed by asset and date. Parameters ---------- *args **kwargs The coordinates to fix along each extra dimension. Returns ------- dataset : Data...
[ "def", "slice", "(", "cls", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "coords", ",", "hash_key", "=", "cls", ".", "_canonical_key", "(", "args", ",", "kwargs", ")", "try", ":", "return", "cls", ".", "_slice_cache", "[", "hash_key", "]", ...
Take a slice of a DataSetFamily to produce a dataset indexed by asset and date. Parameters ---------- *args **kwargs The coordinates to fix along each extra dimension. Returns ------- dataset : DataSet A regular pipeline dataset i...
[ "Take", "a", "slice", "of", "a", "DataSetFamily", "to", "produce", "a", "dataset", "indexed", "by", "asset", "and", "date", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/data/dataset.py#L826-L854
train
quantopian/zipline
zipline/pipeline/loaders/synthetic.py
expected_bar_value
def expected_bar_value(asset_id, date, colname): """ Check that the raw value for an asset/date/column triple is as expected. Used by tests to verify data written by a writer. """ from_asset = asset_id * 100000 from_colname = OHLCV.index(colname) * 1000 from_date = (date - PSEUDO_EPOCH)...
python
def expected_bar_value(asset_id, date, colname): """ Check that the raw value for an asset/date/column triple is as expected. Used by tests to verify data written by a writer. """ from_asset = asset_id * 100000 from_colname = OHLCV.index(colname) * 1000 from_date = (date - PSEUDO_EPOCH)...
[ "def", "expected_bar_value", "(", "asset_id", ",", "date", ",", "colname", ")", ":", "from_asset", "=", "asset_id", "*", "100000", "from_colname", "=", "OHLCV", ".", "index", "(", "colname", ")", "*", "1000", "from_date", "=", "(", "date", "-", "PSEUDO_EPO...
Check that the raw value for an asset/date/column triple is as expected. Used by tests to verify data written by a writer.
[ "Check", "that", "the", "raw", "value", "for", "an", "asset", "/", "date", "/", "column", "triple", "is", "as", "expected", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/synthetic.py#L319-L329
train
quantopian/zipline
zipline/pipeline/loaders/synthetic.py
expected_bar_values_2d
def expected_bar_values_2d(dates, assets, asset_info, colname, holes=None): """ Return an 2D array containing cls.expected_value(asset_id, date, colname) for each date/asset pair in the inputs. M...
python
def expected_bar_values_2d(dates, assets, asset_info, colname, holes=None): """ Return an 2D array containing cls.expected_value(asset_id, date, colname) for each date/asset pair in the inputs. M...
[ "def", "expected_bar_values_2d", "(", "dates", ",", "assets", ",", "asset_info", ",", "colname", ",", "holes", "=", "None", ")", ":", "if", "colname", "==", "'volume'", ":", "dtype", "=", "uint32", "missing", "=", "0", "else", ":", "dtype", "=", "float64...
Return an 2D array containing cls.expected_value(asset_id, date, colname) for each date/asset pair in the inputs. Missing locs are filled with 0 for volume and NaN for price columns: - Values before/after an asset's lifetime. - Values for asset_ids not contained in asset_info. - Locs d...
[ "Return", "an", "2D", "array", "containing", "cls", ".", "expected_value", "(", "asset_id", "date", "colname", ")", "for", "each", "date", "/", "asset", "pair", "in", "the", "inputs", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/synthetic.py#L344-L392
train
quantopian/zipline
zipline/pipeline/loaders/synthetic.py
PrecomputedLoader.load_adjusted_array
def load_adjusted_array(self, domain, columns, dates, sids, mask): """ Load by delegating to sub-loaders. """ out = {} for col in columns: try: loader = self._loaders.get(col) if loader is None: loader = self._loader...
python
def load_adjusted_array(self, domain, columns, dates, sids, mask): """ Load by delegating to sub-loaders. """ out = {} for col in columns: try: loader = self._loaders.get(col) if loader is None: loader = self._loader...
[ "def", "load_adjusted_array", "(", "self", ",", "domain", ",", "columns", ",", "dates", ",", "sids", ",", "mask", ")", ":", "out", "=", "{", "}", "for", "col", "in", "columns", ":", "try", ":", "loader", "=", "self", ".", "_loaders", ".", "get", "(...
Load by delegating to sub-loaders.
[ "Load", "by", "delegating", "to", "sub", "-", "loaders", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/synthetic.py#L82-L97
train
quantopian/zipline
zipline/pipeline/loaders/synthetic.py
SeededRandomLoader.values
def values(self, dtype, dates, sids): """ Make a random array of shape (len(dates), len(sids)) with ``dtype``. """ shape = (len(dates), len(sids)) return { datetime64ns_dtype: self._datetime_values, float64_dtype: self._float_values, int64_dtyp...
python
def values(self, dtype, dates, sids): """ Make a random array of shape (len(dates), len(sids)) with ``dtype``. """ shape = (len(dates), len(sids)) return { datetime64ns_dtype: self._datetime_values, float64_dtype: self._float_values, int64_dtyp...
[ "def", "values", "(", "self", ",", "dtype", ",", "dates", ",", "sids", ")", ":", "shape", "=", "(", "len", "(", "dates", ")", ",", "len", "(", "sids", ")", ")", "return", "{", "datetime64ns_dtype", ":", "self", ".", "_datetime_values", ",", "float64_...
Make a random array of shape (len(dates), len(sids)) with ``dtype``.
[ "Make", "a", "random", "array", "of", "shape", "(", "len", "(", "dates", ")", "len", "(", "sids", "))", "with", "dtype", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/synthetic.py#L147-L158
train
quantopian/zipline
zipline/pipeline/loaders/synthetic.py
SeededRandomLoader._float_values
def _float_values(self, shape): """ Return uniformly-distributed floats between -0.0 and 100.0. """ return self.state.uniform(low=0.0, high=100.0, size=shape)
python
def _float_values(self, shape): """ Return uniformly-distributed floats between -0.0 and 100.0. """ return self.state.uniform(low=0.0, high=100.0, size=shape)
[ "def", "_float_values", "(", "self", ",", "shape", ")", ":", "return", "self", ".", "state", ".", "uniform", "(", "low", "=", "0.0", ",", "high", "=", "100.0", ",", "size", "=", "shape", ")" ]
Return uniformly-distributed floats between -0.0 and 100.0.
[ "Return", "uniformly", "-", "distributed", "floats", "between", "-", "0", ".", "0", "and", "100", ".", "0", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/synthetic.py#L170-L174
train
quantopian/zipline
zipline/pipeline/loaders/synthetic.py
SeededRandomLoader._int_values
def _int_values(self, shape): """ Return uniformly-distributed integers between 0 and 100. """ return (self.state.randint(low=0, high=100, size=shape) .astype('int64'))
python
def _int_values(self, shape): """ Return uniformly-distributed integers between 0 and 100. """ return (self.state.randint(low=0, high=100, size=shape) .astype('int64'))
[ "def", "_int_values", "(", "self", ",", "shape", ")", ":", "return", "(", "self", ".", "state", ".", "randint", "(", "low", "=", "0", ",", "high", "=", "100", ",", "size", "=", "shape", ")", ".", "astype", "(", "'int64'", ")", ")" ]
Return uniformly-distributed integers between 0 and 100.
[ "Return", "uniformly", "-", "distributed", "integers", "between", "0", "and", "100", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/synthetic.py#L176-L181
train
quantopian/zipline
zipline/pipeline/loaders/synthetic.py
SeededRandomLoader._datetime_values
def _datetime_values(self, shape): """ Return uniformly-distributed dates in 2014. """ start = Timestamp('2014', tz='UTC').asm8 offsets = self.state.randint( low=0, high=364, size=shape, ).astype('timedelta64[D]') return start +...
python
def _datetime_values(self, shape): """ Return uniformly-distributed dates in 2014. """ start = Timestamp('2014', tz='UTC').asm8 offsets = self.state.randint( low=0, high=364, size=shape, ).astype('timedelta64[D]') return start +...
[ "def", "_datetime_values", "(", "self", ",", "shape", ")", ":", "start", "=", "Timestamp", "(", "'2014'", ",", "tz", "=", "'UTC'", ")", ".", "asm8", "offsets", "=", "self", ".", "state", ".", "randint", "(", "low", "=", "0", ",", "high", "=", "364"...
Return uniformly-distributed dates in 2014.
[ "Return", "uniformly", "-", "distributed", "dates", "in", "2014", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/pipeline/loaders/synthetic.py#L183-L193
train
quantopian/zipline
zipline/lib/quantiles.py
quantiles
def quantiles(data, nbins_or_partition_bounds): """ Compute rowwise array quantiles on an input. """ return apply_along_axis( qcut, 1, data, q=nbins_or_partition_bounds, labels=False, )
python
def quantiles(data, nbins_or_partition_bounds): """ Compute rowwise array quantiles on an input. """ return apply_along_axis( qcut, 1, data, q=nbins_or_partition_bounds, labels=False, )
[ "def", "quantiles", "(", "data", ",", "nbins_or_partition_bounds", ")", ":", "return", "apply_along_axis", "(", "qcut", ",", "1", ",", "data", ",", "q", "=", "nbins_or_partition_bounds", ",", "labels", "=", "False", ",", ")" ]
Compute rowwise array quantiles on an input.
[ "Compute", "rowwise", "array", "quantiles", "on", "an", "input", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/lib/quantiles.py#L8-L17
train
quantopian/zipline
zipline/finance/metrics/tracker.py
MetricsTracker.handle_minute_close
def handle_minute_close(self, dt, data_portal): """ Handles the close of the given minute in minute emission. Parameters ---------- dt : Timestamp The minute that is ending Returns ------- A minute perf packet. """ self.sync_l...
python
def handle_minute_close(self, dt, data_portal): """ Handles the close of the given minute in minute emission. Parameters ---------- dt : Timestamp The minute that is ending Returns ------- A minute perf packet. """ self.sync_l...
[ "def", "handle_minute_close", "(", "self", ",", "dt", ",", "data_portal", ")", ":", "self", ".", "sync_last_sale_prices", "(", "dt", ",", "data_portal", ")", "packet", "=", "{", "'period_start'", ":", "self", ".", "_first_session", ",", "'period_end'", ":", ...
Handles the close of the given minute in minute emission. Parameters ---------- dt : Timestamp The minute that is ending Returns ------- A minute perf packet.
[ "Handles", "the", "close", "of", "the", "given", "minute", "in", "minute", "emission", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/finance/metrics/tracker.py#L204-L243
train
quantopian/zipline
zipline/finance/metrics/tracker.py
MetricsTracker.handle_market_open
def handle_market_open(self, session_label, data_portal): """Handles the start of each session. Parameters ---------- session_label : Timestamp The label of the session that is about to begin. data_portal : DataPortal The current data portal. """ ...
python
def handle_market_open(self, session_label, data_portal): """Handles the start of each session. Parameters ---------- session_label : Timestamp The label of the session that is about to begin. data_portal : DataPortal The current data portal. """ ...
[ "def", "handle_market_open", "(", "self", ",", "session_label", ",", "data_portal", ")", ":", "ledger", "=", "self", ".", "_ledger", "ledger", ".", "start_of_session", "(", "session_label", ")", "adjustment_reader", "=", "data_portal", ".", "adjustment_reader", "i...
Handles the start of each session. Parameters ---------- session_label : Timestamp The label of the session that is about to begin. data_portal : DataPortal The current data portal.
[ "Handles", "the", "start", "of", "each", "session", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/finance/metrics/tracker.py#L245-L275
train
quantopian/zipline
zipline/finance/metrics/tracker.py
MetricsTracker.handle_market_close
def handle_market_close(self, dt, data_portal): """Handles the close of the given day. Parameters ---------- dt : Timestamp The most recently completed simulation datetime. data_portal : DataPortal The current data portal. Returns -------...
python
def handle_market_close(self, dt, data_portal): """Handles the close of the given day. Parameters ---------- dt : Timestamp The most recently completed simulation datetime. data_portal : DataPortal The current data portal. Returns -------...
[ "def", "handle_market_close", "(", "self", ",", "dt", ",", "data_portal", ")", ":", "completed_session", "=", "self", ".", "_current_session", "if", "self", ".", "emission_rate", "==", "'daily'", ":", "# this method is called for both minutely and daily emissions, but", ...
Handles the close of the given day. Parameters ---------- dt : Timestamp The most recently completed simulation datetime. data_portal : DataPortal The current data portal. Returns ------- A daily perf packet.
[ "Handles", "the", "close", "of", "the", "given", "day", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/finance/metrics/tracker.py#L277-L328
train
quantopian/zipline
zipline/finance/metrics/tracker.py
MetricsTracker.handle_simulation_end
def handle_simulation_end(self, data_portal): """ When the simulation is complete, run the full period risk report and send it out on the results socket. """ log.info( 'Simulated {} trading days\n' 'first open: {}\n' 'last close: {}', ...
python
def handle_simulation_end(self, data_portal): """ When the simulation is complete, run the full period risk report and send it out on the results socket. """ log.info( 'Simulated {} trading days\n' 'first open: {}\n' 'last close: {}', ...
[ "def", "handle_simulation_end", "(", "self", ",", "data_portal", ")", ":", "log", ".", "info", "(", "'Simulated {} trading days\\n'", "'first open: {}\\n'", "'last close: {}'", ",", "self", ".", "_session_count", ",", "self", ".", "_trading_calendar", ".", "session_op...
When the simulation is complete, run the full period risk report and send it out on the results socket.
[ "When", "the", "simulation", "is", "complete", "run", "the", "full", "period", "risk", "report", "and", "send", "it", "out", "on", "the", "results", "socket", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/finance/metrics/tracker.py#L330-L353
train
quantopian/zipline
zipline/extensions.py
create_args
def create_args(args, root): """ Encapsulates a set of custom command line arguments in key=value or key.namespace=value form into a chain of Namespace objects, where each next level is an attribute of the Namespace object on the current level Parameters ---------- args : list A...
python
def create_args(args, root): """ Encapsulates a set of custom command line arguments in key=value or key.namespace=value form into a chain of Namespace objects, where each next level is an attribute of the Namespace object on the current level Parameters ---------- args : list A...
[ "def", "create_args", "(", "args", ",", "root", ")", ":", "extension_args", "=", "{", "}", "for", "arg", "in", "args", ":", "parse_extension_arg", "(", "arg", ",", "extension_args", ")", "for", "name", "in", "sorted", "(", "extension_args", ",", "key", "...
Encapsulates a set of custom command line arguments in key=value or key.namespace=value form into a chain of Namespace objects, where each next level is an attribute of the Namespace object on the current level Parameters ---------- args : list A list of strings representing arguments i...
[ "Encapsulates", "a", "set", "of", "custom", "command", "line", "arguments", "in", "key", "=", "value", "or", "key", ".", "namespace", "=", "value", "form", "into", "a", "chain", "of", "Namespace", "objects", "where", "each", "next", "level", "is", "an", ...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/extensions.py#L6-L28
train
quantopian/zipline
zipline/extensions.py
parse_extension_arg
def parse_extension_arg(arg, arg_dict): """ Converts argument strings in key=value or key.namespace=value form to dictionary entries Parameters ---------- arg : str The argument string to parse, which must be in key=value or key.namespace=value form. arg_dict : dict ...
python
def parse_extension_arg(arg, arg_dict): """ Converts argument strings in key=value or key.namespace=value form to dictionary entries Parameters ---------- arg : str The argument string to parse, which must be in key=value or key.namespace=value form. arg_dict : dict ...
[ "def", "parse_extension_arg", "(", "arg", ",", "arg_dict", ")", ":", "match", "=", "re", ".", "match", "(", "r'^(([^\\d\\W]\\w*)(\\.[^\\d\\W]\\w*)*)=(.*)$'", ",", "arg", ")", "if", "match", "is", "None", ":", "raise", "ValueError", "(", "\"invalid extension argume...
Converts argument strings in key=value or key.namespace=value form to dictionary entries Parameters ---------- arg : str The argument string to parse, which must be in key=value or key.namespace=value form. arg_dict : dict The dictionary into which the key/value pair will be...
[ "Converts", "argument", "strings", "in", "key", "=", "value", "or", "key", ".", "namespace", "=", "value", "form", "to", "dictionary", "entries" ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/extensions.py#L31-L53
train
quantopian/zipline
zipline/extensions.py
update_namespace
def update_namespace(namespace, path, name): """ A recursive function that takes a root element, list of namespaces, and the value being stored, and assigns namespaces to the root object via a chain of Namespace objects, connected through attributes Parameters ---------- namespace : Namespa...
python
def update_namespace(namespace, path, name): """ A recursive function that takes a root element, list of namespaces, and the value being stored, and assigns namespaces to the root object via a chain of Namespace objects, connected through attributes Parameters ---------- namespace : Namespa...
[ "def", "update_namespace", "(", "namespace", ",", "path", ",", "name", ")", ":", "if", "len", "(", "path", ")", "==", "1", ":", "setattr", "(", "namespace", ",", "path", "[", "0", "]", ",", "name", ")", "else", ":", "if", "hasattr", "(", "namespace...
A recursive function that takes a root element, list of namespaces, and the value being stored, and assigns namespaces to the root object via a chain of Namespace objects, connected through attributes Parameters ---------- namespace : Namespace The object onto which an attribute will be add...
[ "A", "recursive", "function", "that", "takes", "a", "root", "element", "list", "of", "namespaces", "and", "the", "value", "being", "stored", "and", "assigns", "namespaces", "to", "the", "root", "object", "via", "a", "chain", "of", "Namespace", "objects", "co...
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/extensions.py#L56-L83
train
quantopian/zipline
zipline/extensions.py
create_registry
def create_registry(interface): """ Create a new registry for an extensible interface. Parameters ---------- interface : type The abstract data type for which to create a registry, which will manage registration of factories for this type. Returns ------- interface : ty...
python
def create_registry(interface): """ Create a new registry for an extensible interface. Parameters ---------- interface : type The abstract data type for which to create a registry, which will manage registration of factories for this type. Returns ------- interface : ty...
[ "def", "create_registry", "(", "interface", ")", ":", "if", "interface", "in", "custom_types", ":", "raise", "ValueError", "(", "'there is already a Registry instance '", "'for the specified type'", ")", "custom_types", "[", "interface", "]", "=", "Registry", "(", "in...
Create a new registry for an extensible interface. Parameters ---------- interface : type The abstract data type for which to create a registry, which will manage registration of factories for this type. Returns ------- interface : type The data type specified/decorated...
[ "Create", "a", "new", "registry", "for", "an", "extensible", "interface", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/extensions.py#L244-L263
train
quantopian/zipline
zipline/extensions.py
Registry.load
def load(self, name): """Construct an object from a registered factory. Parameters ---------- name : str Name with which the factory was registered. """ try: return self._factories[name]() except KeyError: raise ValueError( ...
python
def load(self, name): """Construct an object from a registered factory. Parameters ---------- name : str Name with which the factory was registered. """ try: return self._factories[name]() except KeyError: raise ValueError( ...
[ "def", "load", "(", "self", ",", "name", ")", ":", "try", ":", "return", "self", ".", "_factories", "[", "name", "]", "(", ")", "except", "KeyError", ":", "raise", "ValueError", "(", "\"no %s factory registered under name %r, options are: %r\"", "%", "(", "sel...
Construct an object from a registered factory. Parameters ---------- name : str Name with which the factory was registered.
[ "Construct", "an", "object", "from", "a", "registered", "factory", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/extensions.py#L110-L124
train
quantopian/zipline
zipline/finance/commission.py
calculate_per_unit_commission
def calculate_per_unit_commission(order, transaction, cost_per_unit, initial_commission, min_trade_cost): """ If there is a minimum commission: If the order hasn't had ...
python
def calculate_per_unit_commission(order, transaction, cost_per_unit, initial_commission, min_trade_cost): """ If there is a minimum commission: If the order hasn't had ...
[ "def", "calculate_per_unit_commission", "(", "order", ",", "transaction", ",", "cost_per_unit", ",", "initial_commission", ",", "min_trade_cost", ")", ":", "additional_commission", "=", "abs", "(", "transaction", ".", "amount", "*", "cost_per_unit", ")", "if", "orde...
If there is a minimum commission: If the order hasn't had a commission paid yet, pay the minimum commission. If the order has paid a commission, start paying additional commission once the minimum commission has been reached. If there is no minimum commission: Pay commissio...
[ "If", "there", "is", "a", "minimum", "commission", ":", "If", "the", "order", "hasn", "t", "had", "a", "commission", "paid", "yet", "pay", "the", "minimum", "commission", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/finance/commission.py#L102-L138
train
quantopian/zipline
zipline/finance/commission.py
PerDollar.calculate
def calculate(self, order, transaction): """ Pay commission based on dollar value of shares. """ cost_per_share = transaction.price * self.cost_per_dollar return abs(transaction.amount) * cost_per_share
python
def calculate(self, order, transaction): """ Pay commission based on dollar value of shares. """ cost_per_share = transaction.price * self.cost_per_dollar return abs(transaction.amount) * cost_per_share
[ "def", "calculate", "(", "self", ",", "order", ",", "transaction", ")", ":", "cost_per_share", "=", "transaction", ".", "price", "*", "self", ".", "cost_per_dollar", "return", "abs", "(", "transaction", ".", "amount", ")", "*", "cost_per_share" ]
Pay commission based on dollar value of shares.
[ "Pay", "commission", "based", "on", "dollar", "value", "of", "shares", "." ]
77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe
https://github.com/quantopian/zipline/blob/77ad15e6dc4c1cbcdc133653bac8a63fc704f7fe/zipline/finance/commission.py#L364-L369
train