From 9f99b254521461cdbc4cc98224a3752f948ed9e2 Mon Sep 17 00:00:00 2001 From: Jirka Date: Tue, 13 Feb 2024 12:26:08 +0100 Subject: [PATCH 1/4] refactor: move private cores to subpackage --- cachier/core.py | 8 ++++---- cachier/cores/__init__.py | 0 cachier/{base_core.py => cores/base.py} | 0 cachier/{memory_core.py => cores/memory.py} | 2 +- cachier/{mongo_core.py => cores/mongo.py} | 2 +- cachier/{pickle_core.py => cores/pickle.py} | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) create mode 100644 cachier/cores/__init__.py rename cachier/{base_core.py => cores/base.py} (100%) rename cachier/{memory_core.py => cores/memory.py} (98%) rename cachier/{mongo_core.py => cores/mongo.py} (98%) rename cachier/{pickle_core.py => cores/pickle.py} (99%) diff --git a/cachier/core.py b/cachier/core.py index 7a331f5c..1724e11a 100644 --- a/cachier/core.py +++ b/cachier/core.py @@ -21,10 +21,10 @@ from typing import TYPE_CHECKING, Callable, Literal, Optional, TypedDict, Union from warnings import warn -from .base_core import RecalculationNeeded, _BaseCore -from .memory_core import _MemoryCore -from .mongo_core import _MongoCore -from .pickle_core import _PickleCore +from .cores.base import RecalculationNeeded, _BaseCore +from .cores.memory import _MemoryCore +from .cores.mongo import _MongoCore +from .cores.pickle import _PickleCore if TYPE_CHECKING: import pymongo.collection diff --git a/cachier/cores/__init__.py b/cachier/cores/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/cachier/base_core.py b/cachier/cores/base.py similarity index 100% rename from cachier/base_core.py rename to cachier/cores/base.py diff --git a/cachier/memory_core.py b/cachier/cores/memory.py similarity index 98% rename from cachier/memory_core.py rename to cachier/cores/memory.py index 2a7b6d7b..34d705f4 100644 --- a/cachier/memory_core.py +++ b/cachier/cores/memory.py @@ -3,7 +3,7 @@ import threading from datetime import datetime -from .base_core import _BaseCore +from .base import _BaseCore class _MemoryCore(_BaseCore): diff --git a/cachier/mongo_core.py b/cachier/cores/mongo.py similarity index 98% rename from cachier/mongo_core.py rename to cachier/cores/mongo.py index f16e0a76..18059c9e 100644 --- a/cachier/mongo_core.py +++ b/cachier/cores/mongo.py @@ -20,7 +20,7 @@ except ImportError: # pragma: no cover pass -from .base_core import _BaseCore, RecalculationNeeded +from .base import _BaseCore, RecalculationNeeded MONGO_SLEEP_DURATION_IN_SEC = 1 diff --git a/cachier/pickle_core.py b/cachier/cores/pickle.py similarity index 99% rename from cachier/pickle_core.py rename to cachier/cores/pickle.py index c76ffe77..4fb1c098 100644 --- a/cachier/pickle_core.py +++ b/cachier/cores/pickle.py @@ -17,7 +17,7 @@ # Alternative: https://github.com/WoLpH/portalocker -from .base_core import _BaseCore +from .base import _BaseCore class _PickleCore(_BaseCore): From 132dd2a742c7756acba369c157bf6c0af32cc7b1 Mon Sep 17 00:00:00 2001 From: Jirka Date: Tue, 13 Feb 2024 12:34:56 +0100 Subject: [PATCH 2/4] find_packages --- setup.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 13f92050..63145eb6 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,5 @@ """Setup file for the Cachier package.""" +from setuptools.config.expand import find_packages # This file is part of Cachier. # https://github.com/shaypal5/cachier @@ -30,7 +31,7 @@ author='Shay Palachy', author_email='shay.palachy@gmail.com', url='https://github.com/python-cachier/cachier', - packages=['cachier', 'cachier.scripts'], + packages=find_packages(exclude=['tests']), entry_points=''' [console_scripts] cachier=cachier.scripts.cli:cli From f4ed6f3a7fdb56c6aed2c1ec0887417be8b48e11 Mon Sep 17 00:00:00 2001 From: Jirka Date: Tue, 13 Feb 2024 12:40:39 +0100 Subject: [PATCH 3/4] fix import --- tests/test_mongo_core.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_mongo_core.py b/tests/test_mongo_core.py index 4d9db84e..8d10f8a5 100644 --- a/tests/test_mongo_core.py +++ b/tests/test_mongo_core.py @@ -20,8 +20,8 @@ from pymongo_inmemory import MongoClient as InMemoryMongoClient from cachier import cachier -from cachier.base_core import RecalculationNeeded -from cachier.mongo_core import _MongoCore +from cachier.cores.base import RecalculationNeeded +from cachier.cores.mongo import _MongoCore # === Enables testing vs a real MongoDB instance === From a2d7fc0e5653c420a88d940fa31bda97c026f131 Mon Sep 17 00:00:00 2001 From: Jirka Date: Tue, 13 Feb 2024 15:07:13 +0100 Subject: [PATCH 4/4] monkeypatch.setattr --- tests/test_mongo_core.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/test_mongo_core.py b/tests/test_mongo_core.py index 8d10f8a5..781dd29c 100644 --- a/tests/test_mongo_core.py +++ b/tests/test_mongo_core.py @@ -270,9 +270,9 @@ def mock_get_entry_by_key(self, key): # skipcq: PYL-R0201, PYL-W0613 return "key", None monkeypatch.setattr( - "cachier.mongo_core._MongoCore.get_entry", mock_get_entry) + "cachier.cores.mongo._MongoCore.get_entry", mock_get_entry) monkeypatch.setattr( - "cachier.mongo_core._MongoCore.get_entry_by_key", mock_get_entry_by_key + "cachier.cores.mongo._MongoCore.get_entry_by_key", mock_get_entry_by_key ) @cachier(mongetter=_test_mongetter) @@ -290,7 +290,7 @@ def mock_get_entry_2(self, args, kwargs): # skipcq: PYL-W0613 return "key", entry monkeypatch.setattr( - "cachier.mongo_core._MongoCore.get_entry", mock_get_entry_2) + "cachier.cores.mongo._MongoCore.get_entry", mock_get_entry_2) stale_after = datetime.timedelta(seconds=1)