Merge pull request #1605 from bug-or-feature/feature-1603-improve-path-resolution

Author: bug-or-feature

.github/workflows/os-test.yml

@@ -25,4 +25,8 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip setuptools
-        python -m pip install .
+        python -m pip install '.[dev]'
+
+    - name: Test with pytest
+      run: |
+        pytest syscore/tests/test_fileutils.py

docs/backtesting.md

@@ -3123,7 +3123,6 @@ resolve_path_and_filename_for_package("\\home/rob.file.csv")
 
 ```
 
-
 These functions are used internally whenever a file name is passed in, so feel free to use any of these file formats when specifying eg a configuration filename.
 ```
 ### Absolute: Windows (note use of double backslash in str)
@@ -3136,6 +3135,31 @@ These functions are used internally whenever a file name is passed in, so feel f
 "syscore.tests.pricedata.csv"
 ```
 
+Obviously, using 'dots' as a separator brings limitations, like supporting directories or files with 'dots' in their names. This won't work:
+```
+>>> resolve_path_and_filename_for_package("syscore/tests/price.test.data.csv")
+'/home/user/pysystemtrade/syscore/tests/price/test/data.csv'
+```
+
+do this instead:
+```
+>>> resolve_path_and_filename_for_package("syscore/tests", "price.test.data.csv")
+'/home/user/pysystemtrade/syscore/tests/price.test.data.csv'
+```
+
+This will also not work:
+```
+>>> get_resolved_pathname("data/dir.with.dots")
+'/home/user/pysystemtrade/data/dir/with/dots'
+```
+
+do this instead:
+```
+>>> from pathlib import Path
+>>> get_resolved_pathname(Path("data/dir.with.dots"))
+'/home/user/pysystemtrade/data/dir.with.dots'
+```
+
 ## Logging
 
 ### Basic logging

pyproject.toml

@@ -1,5 +1,8 @@
 [build-system]
-requires = ["setuptools >= 61.0"]
+requires = [
+    "setuptools >= 61.0",
+    "setuptools-scm >= 8.0"
+]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -47,8 +50,11 @@ find = {}
 
 [tool.setuptools.package-data]
 "data" = ["*.csv"]
+"data.futures" = ["*.csv"]
 "private" = ["*.yaml"]
-"sysbrokers" = ["*.csv", "*.yaml"]
+"sysbrokers" = ["*.csv"]
+"sysbrokers.IB" = ["*.yaml"]
+"sysbrokers.IB.config" = ["*.csv"]
 "syscontrol" = ["*.yaml"]
 "sysdata" = ["*.csv"]
 "sysdata.config" = ["*.yaml"]

sysbrokers/IB/ib_trading_hours.py

@@ -1,26 +1,35 @@
 import datetime
 from ib_insync import ContractDetails as ibContractDetails
 
-from sysdata.config.private_directory import get_full_path_for_private_config
+from sysdata.config.private_config import (
+    get_private_config_dir,
+)
 from sysobjects.production.trading_hours.trading_hours import (
     tradingHours,
     listOfTradingHours,
 )
-from syscore.fileutils import does_filename_exist
+from syscore.fileutils import (
+    does_resolved_filename_exist,
+    resolve_path_and_filename_for_package,
+)
 from sysdata.config.production_config import get_production_config
 from sysdata.production.trading_hours import read_trading_hours
 
 IB_CONFIG_TRADING_HOURS_FILE = "sysbrokers.IB.ib_config_trading_hours.yaml"
-PRIVATE_CONFIG_TRADING_HOURS_FILE = get_full_path_for_private_config(
-    "private_config_trading_hours.yaml"
-)
+PRIVATE_CONFIG_TRADING_HOURS_FILE = "private_config_trading_hours.yaml"
 
 
 def get_saved_trading_hours():
-    if does_filename_exist(PRIVATE_CONFIG_TRADING_HOURS_FILE):
-        return read_trading_hours(PRIVATE_CONFIG_TRADING_HOURS_FILE)
+    private_path = resolve_path_and_filename_for_package(
+        get_private_config_dir(), PRIVATE_CONFIG_TRADING_HOURS_FILE
+    )
+    if does_resolved_filename_exist(private_path):
+        return read_trading_hours(private_path)
     else:
-        return read_trading_hours(IB_CONFIG_TRADING_HOURS_FILE)
+        default_path = resolve_path_and_filename_for_package(
+            IB_CONFIG_TRADING_HOURS_FILE
+        )
+        return read_trading_hours(default_path)
 
 
 def get_trading_hours_from_contract_details(

syscore/__init__.py

@@ -0,0 +1,7 @@
+from importlib.util import find_spec
+from pathlib import Path
+
+module_spec = find_spec(__name__)
+path = Path(module_spec.origin)
+
+PYSYS_PROJECT_DIR = path.parent.parent