From 148d2a52736900781f1d6d9a2bf7724df77975ce Mon Sep 17 00:00:00 2001 From: Andrew Liang Date: Thu, 29 Sep 2016 14:54:23 -0400 Subject: [PATCH] MAINT: Rename restrictions.py to asset_restrictions.py For clarity as to what sort of restrictions these are --- tests/finance/test_slippage.py | 2 +- tests/test_algorithm.py | 2 +- tests/test_bar_data.py | 2 +- tests/test_finance.py | 2 +- tests/test_history.py | 2 +- tests/test_restrictions.py | 2 +- tests/test_tradesimulation.py | 2 +- zipline/_protocol.pyx | 2 +- zipline/algorithm.py | 10 +++++----- zipline/api.py | 4 +--- .../finance/{restrictions.py => asset_restrictions.py} | 0 zipline/finance/controls.py | 2 +- zipline/testing/fixtures.py | 2 +- zipline/utils/security_list.py | 2 +- 14 files changed, 17 insertions(+), 19 deletions(-) rename zipline/finance/{restrictions.py => asset_restrictions.py} (100%) diff --git a/tests/finance/test_slippage.py b/tests/finance/test_slippage.py index 48d33b95..ba1ac919 100644 --- a/tests/finance/test_slippage.py +++ b/tests/finance/test_slippage.py @@ -29,7 +29,7 @@ from zipline.finance.slippage import VolumeShareSlippage from zipline.protocol import DATASOURCE_TYPE, BarData from zipline.finance.blotter import Order -from zipline.finance.restrictions import NoRestrictions +from zipline.finance.asset_restrictions import NoRestrictions from zipline.data.data_portal import DataPortal from zipline.testing import tmp_bcolz_equity_minute_bar_reader from zipline.testing.fixtures import ( diff --git a/tests/test_algorithm.py b/tests/test_algorithm.py index a448f714..bfe730e1 100644 --- a/tests/test_algorithm.py +++ b/tests/test_algorithm.py @@ -76,7 +76,7 @@ from zipline.finance.commission import PerShare from zipline.finance.execution import LimitOrder from zipline.finance.order import ORDER_STATUS from zipline.finance.trading import SimulationParameters -from zipline.finance.restrictions import ( +from zipline.finance.asset_restrictions import ( Restriction, HistoricalRestrictions, StaticRestrictions, diff --git a/tests/test_bar_data.py b/tests/test_bar_data.py index b4b1e170..e3ef7edc 100644 --- a/tests/test_bar_data.py +++ b/tests/test_bar_data.py @@ -23,7 +23,7 @@ import pandas as pd from zipline._protocol import handle_non_market_minutes -from zipline.finance.restrictions import ( +from zipline.finance.asset_restrictions import ( Restriction, HistoricalRestrictions, RESTRICTION_STATES, diff --git a/tests/test_finance.py b/tests/test_finance.py index 488d52c7..bd84ba9b 100644 --- a/tests/test_finance.py +++ b/tests/test_finance.py @@ -37,7 +37,7 @@ from zipline.data.minute_bars import BcolzMinuteBarReader from zipline.data.data_portal import DataPortal from zipline.data.us_equity_pricing import BcolzDailyBarWriter from zipline.finance.slippage import FixedSlippage -from zipline.finance.restrictions import NoRestrictions +from zipline.finance.asset_restrictions import NoRestrictions from zipline.protocol import BarData from zipline.testing import ( tmp_trading_env, diff --git a/tests/test_history.py b/tests/test_history.py index d1ae15eb..233d879d 100644 --- a/tests/test_history.py +++ b/tests/test_history.py @@ -28,7 +28,7 @@ from zipline.errors import ( HistoryWindowStartsBeforeData, ) from zipline.finance.trading import SimulationParameters -from zipline.finance.restrictions import NoRestrictions +from zipline.finance.asset_restrictions import NoRestrictions from zipline.testing import ( create_minute_df_for_asset, str_to_seconds, diff --git a/tests/test_restrictions.py b/tests/test_restrictions.py index aa6d50cb..64e3f500 100644 --- a/tests/test_restrictions.py +++ b/tests/test_restrictions.py @@ -5,7 +5,7 @@ from functools import partial from toolz import groupby -from zipline.finance.restrictions import ( +from zipline.finance.asset_restrictions import ( RESTRICTION_STATES, Restriction, HistoricalRestrictions, diff --git a/tests/test_tradesimulation.py b/tests/test_tradesimulation.py index 428d409b..6277b8e2 100644 --- a/tests/test_tradesimulation.py +++ b/tests/test_tradesimulation.py @@ -24,7 +24,7 @@ from zipline import TradingAlgorithm from zipline.gens.sim_engine import BEFORE_TRADING_START_BAR from zipline.finance.performance import PerformanceTracker -from zipline.finance.restrictions import NoRestrictions +from zipline.finance.asset_restrictions import NoRestrictions from zipline.gens.tradesimulation import AlgorithmSimulator from zipline.sources.benchmark_source import BenchmarkSource from zipline.test_algorithms import NoopAlgorithm diff --git a/zipline/_protocol.pyx b/zipline/_protocol.pyx index b15159fd..43e7d20d 100644 --- a/zipline/_protocol.pyx +++ b/zipline/_protocol.pyx @@ -153,7 +153,7 @@ cdef class BarData: data_frequency : {'minute', 'daily'} The frequency of the bar data; i.e. whether the data is daily or minute bars - restrictions : zipline.finance.restrictions.Restrictions + restrictions : zipline.finance.asset_restrictions.Restrictions Object that combines and returns restricted list information from multiple sources universe_func : callable, optional diff --git a/zipline/algorithm.py b/zipline/algorithm.py index 9e2e579c..df437706 100644 --- a/zipline/algorithm.py +++ b/zipline/algorithm.py @@ -76,13 +76,13 @@ from zipline.finance.execution import ( StopOrder, ) from zipline.finance.performance import PerformanceTracker -from zipline.finance.restrictions import Restrictions +from zipline.finance.asset_restrictions import Restrictions from zipline.finance.slippage import ( VolumeShareSlippage, SlippageModel ) from zipline.finance.cancel_policy import NeverCancel, CancelPolicy -from zipline.finance.restrictions import ( +from zipline.finance.asset_restrictions import ( NoRestrictions, StaticRestrictions, SecurityListRestrictions, @@ -2185,8 +2185,8 @@ class TradingAlgorithm(object): else: warnings.warn( "`set_do_not_order_list(container_of_assets)` is deprecated. " - "Create a zipline.finance.restrictions.StaticRestrictions " - "object with a container of assets and use " + "Create a zipline.finance.asset_restrictions." + "StaticRestrictions object with a container of assets and use " "`set_asset_restrictions(StaticRestrictions(" "container_of_assets))` instead.", category=ZiplineDeprecationWarning, @@ -2211,7 +2211,7 @@ class TradingAlgorithm(object): See Also -------- - zipline.finance.restrictions.Restrictions + zipline.finance.asset_restrictions.Restrictions """ control = RestrictedListOrder(on_error, restrictions) self.register_trading_control(control) diff --git a/zipline/api.py b/zipline/api.py index f3e345ac..68b78714 100644 --- a/zipline/api.py +++ b/zipline/api.py @@ -16,12 +16,11 @@ # Note that part of the API is implemented in TradingAlgorithm as # methods (e.g. order). These are added to this namespace via the # decorator ``api_method`` inside of algorithm.py. -from .finance.restrictions import ( +from .finance.asset_restrictions import ( Restriction, StaticRestrictions, HistoricalRestrictions, RESTRICTION_STATES, - SecurityListRestrictions, ) from .finance import commission, execution, slippage, cancel_policy from .finance.cancel_policy import ( @@ -47,7 +46,6 @@ __all__ = [ 'StaticRestrictions', 'HistoricalRestrictions', 'RESTRICTION_STATES', - 'SecurityListRestrictions', 'cancel_policy', 'commission', 'date_rules', diff --git a/zipline/finance/restrictions.py b/zipline/finance/asset_restrictions.py similarity index 100% rename from zipline/finance/restrictions.py rename to zipline/finance/asset_restrictions.py diff --git a/zipline/finance/controls.py b/zipline/finance/controls.py index 95d61c89..ca31a462 100644 --- a/zipline/finance/controls.py +++ b/zipline/finance/controls.py @@ -137,7 +137,7 @@ class RestrictedListOrder(TradingControl): Parameters ---------- - restrictions : zipline.finance.restrictions.Restrictions + restrictions : zipline.finance.asset_restrictions.Restrictions Object representing restrictions of a group of assets. """ diff --git a/zipline/testing/fixtures.py b/zipline/testing/fixtures.py index eb6bd0f9..3570d255 100644 --- a/zipline/testing/fixtures.py +++ b/zipline/testing/fixtures.py @@ -36,7 +36,7 @@ from ..utils.classproperty import classproperty from ..utils.final import FinalMeta, final from .core import tmp_asset_finder, make_simple_equity_info from zipline.assets import Equity, Future -from zipline.finance.restrictions import NoRestrictions +from zipline.finance.asset_restrictions import NoRestrictions from zipline.pipeline import SimplePipelineEngine from zipline.pipeline.loaders.testing import make_seeded_random_loader from zipline.protocol import BarData diff --git a/zipline/utils/security_list.py b/zipline/utils/security_list.py index e871dedd..2a72952c 100644 --- a/zipline/utils/security_list.py +++ b/zipline/utils/security_list.py @@ -8,7 +8,7 @@ import pytz import zipline from zipline.errors import SymbolNotFound -from zipline.finance.restrictions import SecurityListRestrictions +from zipline.finance.asset_restrictions import SecurityListRestrictions from zipline.zipline_warnings import ZiplineDeprecationWarning