chore: Update .gitignore and pyproject.toml for improved dependency management and ignore patterns (#6)

Author: NFUChen

.gitignore

@@ -160,3 +160,10 @@ cython_debug/
 # and can be added to the global gitignore or merged into this file. For a more nuclear
 # option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+src/
+app-config.json
+application-properties.json
+main.py
+pdm.lock
+*.db

py_spring_model/core/model.py

@@ -1,5 +1,6 @@
 import contextlib
-from typing import ClassVar, Iterator, Optional, Type, Self
+from typing_extensions import Self
+from typing import ClassVar, Iterator, Optional, Type
 from loguru import logger
 from sqlalchemy import Engine, MetaData
 from sqlalchemy.engine.base import Connection

py_spring_model/py_spring_model_provider.py

@@ -3,10 +3,7 @@
 
 import py_spring_core.core.utils as core_utils
 from loguru import logger
-from py_spring_core import Component, EntityProvider
-from py_spring_core.core.application.context.application_context import (
- ApplicationContext,
-)
+from py_spring_core import Component, EntityProvider, ApplicationContextRequired
 from sqlalchemy import create_engine
 from sqlalchemy.exc import InvalidRequestError as SqlAlehemyInvalidRequestError
 from sqlmodel import SQLModel
@@ -26,7 +23,7 @@
 class ApplicationContextNotSetError(Exception): ...
 
 
-class PySpringModelProvider(EntityProvider, Component):
+class PySpringModelProvider(EntityProvider, Component, ApplicationContextRequired):
  """
  The `PySpringModelProvider` class is responsible for initializing the PySpring model provider, which includes:
  - Grouping file paths into class files and model files
@@ -38,15 +35,22 @@ class PySpringModelProvider(EntityProvider, Component):
  This class is a key component in the PySpring model infrastructure, handling the setup and initialization of the model-related functionality.
  """
 
- props: PySpringModelProperties
+ def _get_props(self) -> PySpringModelProperties:
+ app_context = self.get_application_context()
+ assert app_context is not None
+ props = app_context.get_properties(PySpringModelProperties)
+ assert props is not None
+ return props
 
  def _group_file_paths(self, files: Iterable[str]) -> ApplicationFileGroups:
+ props = self._get_props()
+
  class_files: set[str] = set()
  model_files: set[str] = set()
 
  for file in files:
  py_file_name = self._get_file_base_name(file)
- if py_file_name in self.props.model_file_postfix_patterns:
+ if py_file_name in props.model_file_postfix_patterns:
  model_files.add(file)
  if file not in model_files:
  class_files.add(file)
@@ -76,6 +80,7 @@ def import_func_wrapper() -> set[type[object]]:
  self._model_classes = self._get_pyspring_model_inheritors()
 
  def _is_from_model_file(self, cls: Type[object]) -> bool:
+ props = self._get_props()
  try:
  source_file_name = inspect.getsourcefile(cls)
  except TypeError as error:
@@ -86,7 +91,7 @@ def _is_from_model_file(self, cls: Type[object]) -> bool:
  if source_file_name is None:
  return False
  py_file_name = self._get_file_base_name(source_file_name) # e.g., models.py
- return py_file_name in self.props.model_file_postfix_patterns
+ return py_file_name in props.model_file_postfix_patterns
 
  def _get_file_base_name(self, file_path: str) -> str:
  return file_path.split("/")[-1]
@@ -126,34 +131,30 @@ def _create_all_tables(self) -> None:
  RepositoryBase.connection = self.sql_engine.connect()
 
  def provider_init(self) -> None:
- self.app_context: ApplicationContext
+ props = self._get_props()
  logger.info(
  f"[PYSPRING MODEL PROVIDER INIT] Initialize PySpringModelProvider with app context: {self.app_context}"
  )
- if self.app_context is None:
- raise ApplicationContextNotSetError(
- "AppContext is not set by the framework"
- )
+ app_context = self.get_application_context()
 
- self.app_file_groups = self._group_file_paths(self.app_context.all_file_paths)
+ self.app_file_groups = self._group_file_paths(app_context.all_file_paths)
  self.sql_engine = create_engine(
- url=self.props.sqlalchemy_database_uri, echo=True
+ url=props.sqlalchemy_database_uri, echo=True
  )
- if self.app_context is None:
- raise ApplicationContextNotSetError(
- "AppContext is not set by the framework"
- )
  self._import_model_modules()
  self._create_all_tables()
 
 
 def provide_py_spring_model() -> EntityProvider:
  return PySpringModelProvider(
- rest_controller_classes=[PySpringModelRestController],
+ rest_controller_classes=[
+ # PySpringModelRestController
+ ],
  component_classes=[
- PySpringModelProvider,
- PySpringModelRestService,
- CrudRepositoryImplementationService,
- ], # injecting self for getting properties
- properties_classes=[PySpringModelProperties],
+ # PySpringModelRestService,
+ # CrudRepositoryImplementationService,
+ ],
+ properties_classes=[
+ PySpringModelProperties
+ ],
  )

py_spring_model/py_spring_model_rest/controller/py_spring_model_rest_controller.py

@@ -17,7 +17,7 @@ class PySpringModelRestController(RestController):
 
  rest_service: PySpringModelRestService
 
- def register_routes(self) -> None:
+ def post_construct(self) -> None:
  self._register_resource_for_models()
 
  def _register_resource_for_models(self) -> None:

py_spring_model/py_spring_model_rest/service/curd_repository_implementation_service/crud_repository_implementation_service.py

@@ -172,7 +172,7 @@ def decorator(func: Callable[P, RT]) -> Callable[P, RT]:
  func_full_name = func.__qualname__
  CrudRepositoryImplementationService.add_skip_function(func_full_name)
  @functools.wraps(func)
- def wrapper(*args, **kwargs) -> RT:
+ def wrapper(*args: P.args, **kwargs: P.kwargs) -> RT:
  nonlocal query_template
  RETURN = "return"
 

pyproject.toml

@@ -6,11 +6,11 @@ authors = [
  {name = "William Chen", email = "william_w_chen@trendmicro.com"},
 ]
 dependencies = [
- "py-spring-core>=0.0.5",
- "isort>=5.13.2",
- "sqlmodel>=0.0.22",
+ "py-spring-core>=0.0.13",
+ "sqlmodel>=0.0.24",
 ]
-requires-python = ">=3.11"
+
+requires-python = ">=3.10, <3.13"
 readme = "README.md"
 license = {text = "MIT"}
 
@@ -30,4 +30,3 @@ dev = [
  "pytest>=8.3.2",
  "pytest-mock>=3.14.0",
 ]
-