sqlobjects 1.8.0__py3-none-any.whl → 1.9.1__py3-none-any.whl

sqlobjects/__init__.py

@@ -16,7 +16,7 @@ from .objects import (
     TransactionMode,
 )
 from .queryset import Q, QuerySet
-from .sql_logging import SQLCallerFilter, get_caller_frame
+from .sql_logging import ObjectLogger, get_caller_frame
 
 
 __version__ = "0.3.0"
@@ -43,6 +43,6 @@ __all__ = [
     "ErrorHandling",
     "ConflictResolution",
     # SQL logging
-    "SQLCallerFilter",
+    "ObjectLogger",
     "get_caller_frame",
 ]

sqlobjects/queries/builder.py

@@ -70,16 +70,16 @@ class QueryBuilder:
         return new_builder
 
     def add_ordering(self, *fields):
-        """Add ORDER BY fields to the query.
+        """Set ORDER BY fields for the query, replacing any existing ordering.
 
         Args:
             *fields: Field names or SQLAlchemy ordering expressions
 
         Returns:
-            New QueryBuilder instance with added ordering
+            New QueryBuilder instance with replaced ordering
         """
         new_builder = self.copy()
-        new_builder.ordering.extend(fields)
+        new_builder.ordering = list(fields)
         return new_builder
 
     def add_limit(self, count: int):

sqlobjects/queries/executor.py

@@ -14,8 +14,7 @@ from sqlalchemy import (
     update,
 )
 
-
-_sql_logger = logging.getLogger("sqlobjects.sql")
+from ..sql_logging import _sql_logger
 
 
 _T = TypeVar("_T")

sqlobjects/sql_logging.py

@@ -1,9 +1,9 @@
 """SQL logging utilities for sqlobjects.
 
-Provides get_caller_frame() to surface user-code caller information in SQL log
-records, compatible with standard logging and loguru.
+Provides ObjectLogger (a logging.Logger subclass that auto-rewrites caller
+fields to user-code location) and get_caller_frame() for custom scenarios.
 
-Filter strategy:
+Frame-skip strategy:
 - Skips frames from site-packages (covers pip-installed sqlobjects/sqlalchemy)
 - Skips frames whose module name starts with "sqlobjects." or "sqlalchemy."
   (covers editable installs via `pip install -e .`)
@@ -15,12 +15,14 @@ from __future__ import annotations
 import inspect
 import logging
 import os
+from collections.abc import Mapping
+from typing import Any
 
 
-__all__ = ["get_caller_frame", "SQLCallerFilter"]
+__all__ = ["get_caller_frame", "ObjectLogger"]
 
 # Exact module names that are always considered internal
-_INTERNAL_MODULES = {"sqlobjects", "sqlalchemy"}
+_INTERNAL_MODULES = {"sqlobjects", "sqlalchemy", "logging"}
 
 # Module name prefixes that are always considered internal
 _INTERNAL_PREFIXES = ("sqlobjects.", "sqlalchemy.")
@@ -29,6 +31,48 @@ _INTERNAL_PREFIXES = ("sqlobjects.", "sqlalchemy.")
 _THIS_FILE = os.path.abspath(__file__)
 
 
+def _should_skip_frame(
+    filepath: str,
+    module: str,
+    extra_skip_prefixes: tuple[str, ...],
+) -> bool:
+    """Return True if this frame should be skipped (library/internal frame).
+
+    Args:
+        filepath: frame_info.filename
+        module: frame.f_globals.get("__name__", "")
+        extra_skip_prefixes: tuple of module name prefixes to skip in addition
+            to the built-in sqlobjects/sqlalchemy prefixes.
+    """
+    if "site-packages" in filepath:
+        return True
+    if filepath.startswith("<"):
+        return True
+    if module in _INTERNAL_MODULES or module.startswith(_INTERNAL_PREFIXES):
+        return True
+    if filepath == _THIS_FILE or os.path.abspath(filepath) == _THIS_FILE:
+        return True
+    if extra_skip_prefixes and module.startswith(extra_skip_prefixes):
+        return True
+    return False
+
+
+def _find_user_frame(
+    extra_skip_packages: list[str] | None = None,
+) -> inspect.FrameInfo | None:
+    """Return the first user-code FrameInfo, skipping library frames.
+
+    Applies the same skip rules as get_caller_frame() but returns the raw
+    FrameInfo instead of a formatted string. Returns None if no frame found.
+    """
+    extra_skip_prefixes: tuple[str, ...] = tuple(extra_skip_packages) if extra_skip_packages else ()
+    for frame_info in inspect.stack():
+        module = frame_info.frame.f_globals.get("__name__", "")
+        if not _should_skip_frame(frame_info.filename, module, extra_skip_prefixes):
+            return frame_info
+    return None
+
+
 def get_caller_frame(
     extra_skip_packages: list[str] | None = None,
     max_frames: int = 1,
@@ -50,37 +94,20 @@ def get_caller_frame(
         Frame string "path/to/file.py:lineno in funcname", or a list of such
         strings when max_frames > 1.
     """
-    skip_prefixes = _INTERNAL_PREFIXES
-    if extra_skip_packages:
-        skip_prefixes = skip_prefixes + tuple(extra_skip_packages)
-
+    extra_skip_prefixes: tuple[str, ...] = tuple(extra_skip_packages) if extra_skip_packages else ()
     frames: list[str] = []
 
     for frame_info in inspect.stack():
-        filepath = frame_info.filename
         module = frame_info.frame.f_globals.get("__name__", "")
-
-        # Skip site-packages frames (pip-installed third-party libs)
-        if "site-packages" in filepath:
-            continue
-
-        # Skip sqlobjects/sqlalchemy frames (editable install)
-        if module in _INTERNAL_MODULES or module.startswith(skip_prefixes):
-            continue
-
-        # Skip this helper file itself
-        if os.path.abspath(filepath) == _THIS_FILE:
+        if _should_skip_frame(frame_info.filename, module, extra_skip_prefixes):
             continue
-
-        rel_path = _relative_path(filepath)
+        rel_path = _relative_path(frame_info.filename)
         frames.append(f"{rel_path}:{frame_info.lineno} in {frame_info.function}")
-
         if len(frames) >= max_frames:
             break
 
     if not frames:
         return "<unknown>" if max_frames == 1 else ["<unknown>"]
-
     return frames[0] if max_frames == 1 else frames
 
 
@@ -92,65 +119,82 @@ def _relative_path(filepath: str) -> str:
         return filepath
 
 
-class SQLCallerFilter(logging.Filter):
-    """logging.Filter that rewrites LogRecord caller fields to user-code location.
-
-    Inspects the call stack at filter time, skips library frames (site-packages
-    and sqlobjects.*/sqlalchemy.* modules for editable installs), and overwrites
-    record.filename / record.funcName / record.lineno / record.pathname so that
-    any handler (including loguru interception) displays the real user-code
-    call site.
+class ObjectLogger(logging.Logger):
+    """logging.Logger subclass that rewrites LogRecord caller fields to user-code location.
 
-    Also exposes record.caller (str or list[str]) for use in custom Formatters.
+    Overrides makeRecord() to replace the standard caller fields
+    (filename, funcName, lineno, pathname) with the first user-code frame
+    found by _find_user_frame(). This means any handler attached to this logger
+    — including loguru InterceptHandlers — will display the real call site
+    without any additional Filter configuration.
 
     Args:
-        max_frames: Number of user-code frames to capture (default 1).
-            When 1, record.caller is a str and record location fields point
-            to that single frame.
-            When > 1, record.caller is a list[str] and record location fields
-            are set from the first (most recent) frame.
-        extra_skip_packages: Additional module name prefixes to skip
-            (matched against frame's __name__).
+        name: Logger name (passed to logging.Logger).
+        level: Initial log level (default NOTSET).
+        extra_skip_packages: Additional module name prefixes to skip when
+            searching for the user-code frame (e.g. ["myapp.middleware"]).
     """
 
     def __init__(
         self,
-        max_frames: int = 1,
+        name: str,
+        level: int = logging.NOTSET,
         extra_skip_packages: list[str] | None = None,
     ) -> None:
-        super().__init__()
-        self.max_frames = max_frames
-        self.extra_skip_packages: list[str] | None = list(extra_skip_packages) if extra_skip_packages else None
+        super().__init__(name, level)
+        self.extra_skip_packages = extra_skip_packages
 
-    def filter(self, record: logging.LogRecord) -> bool:
-        caller = get_caller_frame(
-            extra_skip_packages=self.extra_skip_packages,
-            max_frames=self.max_frames,
-        )
-        record.caller = caller
+    def makeRecord(  # noqa: N802
+        self,
+        name: str,
+        level: int,
+        fn: str,
+        lno: int,
+        msg: object,
+        args: Any,
+        exc_info: Any,
+        func: str | None = None,
+        extra: Mapping[str, object] | None = None,
+        sinfo: str | None = None,
+    ) -> logging.LogRecord:
+        record = super().makeRecord(name, level, fn, lno, msg, args, exc_info, func, extra, sinfo)
+        frame_info = _find_user_frame(self.extra_skip_packages)
+        if frame_info:
+            record.pathname = os.path.abspath(frame_info.filename)
+            record.filename = os.path.basename(frame_info.filename)
+            record.module = os.path.splitext(record.filename)[0]
+            record.funcName = frame_info.function
+            record.lineno = frame_info.lineno
+        return record
 
-        # Overwrite standard location fields from the first user frame
-        first = caller if isinstance(caller, str) else caller[0]
-        self._overwrite_record_location(record, first)
 
-        return True
+def _install_object_logger(name: str) -> ObjectLogger:
+    """Create an ObjectLogger and register it in the logging system.
 
-    @staticmethod
-    def _overwrite_record_location(record: logging.LogRecord, frame_str: str) -> None:
-        """Parse 'path/to/file.py:lineno in funcname' and overwrite record fields.
-
-        Frame string format: "relative/path/to/file.py:42 in func_name"
-        Uses rsplit to handle edge cases where function name could have spaces.
-        """
-        try:
-            # Split off the function name part (rightmost " in ")
-            path_part, func_part = frame_str.rsplit(" in ", 1)
-            # Split off the line number (rightmost ":")
-            filepath, lineno_str = path_part.rsplit(":", 1)
-            record.pathname = os.path.abspath(filepath)
-            record.filename = os.path.basename(filepath)
-            record.module = os.path.splitext(record.filename)[0]
-            record.funcName = func_part.strip()
-            record.lineno = int(lineno_str)
-        except (ValueError, AttributeError):
-            pass  # Keep original fields if parsing fails
+    Directly writes into logging.root.manager.loggerDict so that
+    logging.getLogger(name) returns this ObjectLogger instance.
+    Migrates handlers, level, and propagate from any pre-existing Logger
+    (but not from PlaceHolder sentinels, which are logging internals).
+
+    Thread-safe: acquires the logging module lock during the operation.
+
+    Known limitation: code that obtained a reference via getLogger(name)
+    *before* this function runs will still hold the old Logger instance.
+    """
+    with logging._lock:  # type: ignore[attr-defined]  # noqa: SLF001
+        existing = logging.root.manager.loggerDict.get(name)
+        logger = ObjectLogger(name)
+        logger.parent = logging.root
+        logger.propagate = True
+        if isinstance(existing, logging.Logger):
+            for handler in existing.handlers:
+                logger.addHandler(handler)
+            if existing.level != logging.NOTSET:
+                logger.setLevel(existing.level)
+            logger.propagate = existing.propagate
+        logging.root.manager.loggerDict[name] = logger
+    return logger
+
+
+# Module-level instance — imported by executor.py and usable by callers
+_sql_logger: ObjectLogger = _install_object_logger("sqlobjects.sql")

{sqlobjects-1.8.0.dist-info → sqlobjects-1.9.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlobjects
-Version: 1.8.0
+Version: 1.9.1
 Summary: Django-style async ORM library based on SQLAlchemy with chainable queries, Q objects, and relationship loading
 Author-email: XtraVisions <gitadmin@xtravisions.com>, Chen Hao <chenhao@xtravisions.com>
 Maintainer-email: XtraVisions <gitadmin@xtravisions.com>, Chen Hao <chenhao@xtravisions.com>

{sqlobjects-1.8.0.dist-info → sqlobjects-1.9.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-sqlobjects/__init__.py,sha256=RLpjGDyRKjiR1ZFs2Gg831VHkJwHnuXP8eWZ1aCAshk,1101
+sqlobjects/__init__.py,sha256=ALRG6rLlzRTecmSu1x8dA5Z7Y_XS3mOvYom8mlZuqJw,1095
 sqlobjects/_install_rules.py,sha256=ndw9815-60WY_ORGUefijUBnoUHPd0NBzUkCL8mQLKc,4053
 sqlobjects/cascade.py,sha256=QzNNJLf-jeh-p12Do7w2G8j-DYAVoqp1-cDATBhjRP8,39522
 sqlobjects/exceptions.py,sha256=IEp5XV6N3hc3SAU-C3F-5D6jEZU_p72mufvwVhaStHo,16592
@@ -8,7 +8,7 @@ sqlobjects/model.py,sha256=3cws701s1f788CTOoyTRHAKgZnH4rfn_c6tVx9wyTBs,19582
 sqlobjects/queryset.py,sha256=CjOWmUyuvGmcs2zTPRSrHwNpRwYCulYYz2ygw9IbIKc,50155
 sqlobjects/session.py,sha256=r11ZvIilL-ptFu1qZdmMEhYN9UxD1sq1qihRu2WUf7g,15542
 sqlobjects/signals.py,sha256=N4mhotmMy_Ub-XJCvdlfsQ767KVzPbbJdF0JlJ405Oc,17454
-sqlobjects/sql_logging.py,sha256=9ZZmqqfU8fJAgkXW0Abqd7JnNPmYTGH7enK0CFgMut4,5653
+sqlobjects/sql_logging.py,sha256=LGnhKtLvoHcGVnclEG31rBavvD28iBREpvxsmmcxgu4,7370
 sqlobjects/validators.py,sha256=aqP7YgCnx-cjthqRo2RD-Iz2lvFsJsDgT73HwLwZGxE,10334
 sqlobjects/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sqlobjects/contrib/asgi.py,sha256=9-kOMAHA2xkKkgc2djec2sew6Og2dr3jGtQGd5oPrrM,1931
@@ -51,24 +51,24 @@ sqlobjects/objects/bulk.py,sha256=p81KZLQY90VKHjQCN7vuYPLh-TFcLE7h9b8MYVsHIi0,39
 sqlobjects/objects/core.py,sha256=uVRqFSLv-0cLdiGd9BS8c_an8jFD-S985oghWM_B46c,36666
 sqlobjects/objects/upsert.py,sha256=cqV3SEppI_mkWbhKFTslmMeVSuNREYzKy-HjUMexGTk,2516
 sqlobjects/queries/__init__.py,sha256=A9bXXsvht7HYjz8diDYLCEPX96Fr7T4eQh_iJfl4ToA,216
-sqlobjects/queries/builder.py,sha256=8RLs1te4wKTsYJViwBNX-ioDy2PV92kl6BXoNB7NmPw,26727
+sqlobjects/queries/builder.py,sha256=hjNxYnddU1IWffDa5AtwaeG-d4_ZEcfg51IYLdVGOaE,26764
 sqlobjects/queries/dialect.py,sha256=_rMKbqKfdAvVoDwE17nF1lcL7nH7fyaNQHVhwD232i4,8003
-sqlobjects/queries/executor.py,sha256=YzOKXiyjqtuR7t8kfnSLYM2HiXeeITppZewbtXLdKBQ,18933
+sqlobjects/queries/executor.py,sha256=6gc6Hwx72mUC4EeISBNCZ4YR0vdfTXsw8Yj1kmuIXP0,18920
 sqlobjects/utils/__init__.py,sha256=NsJ52Fl_PaB-2WlOIJVGNPmgOnqPmvYRmp7uaq5zfYs,192
 sqlobjects/utils/inspect.py,sha256=u-Q9VBoSGYCE_3Soy8jMuCAdM-P7IkSzTxqrJop_Ilk,2612
 sqlobjects/utils/naming.py,sha256=PmfNuEz-Twly2qREjKfMNulJt8TmOUJaxzFTuts3COg,1411
 sqlobjects/utils/pattern.py,sha256=FGCgobTpnmKjdAtQidHIg4Xa2CQLeP35F0VuX_1T1dk,14740
-sqlobjects-1.8.0.data/data/share/sqlobjects/rules/01-database-session-guide.md,sha256=m6WnTHyPAEI9z5-ehfQJQACaI7Hy0gcnzpgG1mW_Nhw,9220
-sqlobjects-1.8.0.data/data/share/sqlobjects/rules/02-model-definition-guide.md,sha256=i5gNJM-0bIJ2xSUu3mij8uB9kJC9EAc_439sCBqRph8,10977
-sqlobjects-1.8.0.data/data/share/sqlobjects/rules/03-query-operations-guide.md,sha256=U3ZAs-U020lnfxvzM7CKTrREegCf8zB7zBW7sJWxEAA,11867
-sqlobjects-1.8.0.data/data/share/sqlobjects/rules/04-crud-operations-guide.md,sha256=abUEvRPSiSjX8enclXO5Uryox9Rt0WFeRcFkvHXfPf8,10085
-sqlobjects-1.8.0.data/data/share/sqlobjects/rules/05-relationships-guide.md,sha256=PclRgzoCe_P1Pgy6dSvL6OZe2Ph_wBIkHtjktbufe7g,12368
-sqlobjects-1.8.0.data/data/share/sqlobjects/rules/06-validation-signals-guide.md,sha256=i9WLLhyCDoWGkIYqH2D_XLn98oMbF1pB3-L-b5gRbT4,14294
-sqlobjects-1.8.0.data/data/share/sqlobjects/rules/07-performance-guide.md,sha256=rjR0DjT39poEBVaUxAzJBEaMaBrZKLVer1zXaNNYfxg,12851
-sqlobjects-1.8.0.data/data/share/sqlobjects/rules/README.md,sha256=d2n5ZZT8LGvjL60u_HlzXn2uA8FwoCgqG3fuAhvMFvM,2280
-sqlobjects-1.8.0.dist-info/licenses/LICENSE,sha256=ScFR7nvWIhar0d32Y-LA4vqp9zNmy1HSJia7UX7jU6c,1068
-sqlobjects-1.8.0.dist-info/METADATA,sha256=5kP5QZh-83Ot--vd_lCwxZuF8nrZOAzZWrpiRFyH_r0,13740
-sqlobjects-1.8.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-sqlobjects-1.8.0.dist-info/entry_points.txt,sha256=9Q3Ci55MawxkQhMlR_eLJui00_rYYIVO_Aq_Dm0u5MQ,76
-sqlobjects-1.8.0.dist-info/top_level.txt,sha256=brO5vDtCpn4L9dpX0EHpehbu4kcHaK_2Bbnwze35YKc,11
-sqlobjects-1.8.0.dist-info/RECORD,,
+sqlobjects-1.9.1.data/data/share/sqlobjects/rules/01-database-session-guide.md,sha256=m6WnTHyPAEI9z5-ehfQJQACaI7Hy0gcnzpgG1mW_Nhw,9220
+sqlobjects-1.9.1.data/data/share/sqlobjects/rules/02-model-definition-guide.md,sha256=i5gNJM-0bIJ2xSUu3mij8uB9kJC9EAc_439sCBqRph8,10977
+sqlobjects-1.9.1.data/data/share/sqlobjects/rules/03-query-operations-guide.md,sha256=U3ZAs-U020lnfxvzM7CKTrREegCf8zB7zBW7sJWxEAA,11867
+sqlobjects-1.9.1.data/data/share/sqlobjects/rules/04-crud-operations-guide.md,sha256=abUEvRPSiSjX8enclXO5Uryox9Rt0WFeRcFkvHXfPf8,10085
+sqlobjects-1.9.1.data/data/share/sqlobjects/rules/05-relationships-guide.md,sha256=PclRgzoCe_P1Pgy6dSvL6OZe2Ph_wBIkHtjktbufe7g,12368
+sqlobjects-1.9.1.data/data/share/sqlobjects/rules/06-validation-signals-guide.md,sha256=i9WLLhyCDoWGkIYqH2D_XLn98oMbF1pB3-L-b5gRbT4,14294
+sqlobjects-1.9.1.data/data/share/sqlobjects/rules/07-performance-guide.md,sha256=rjR0DjT39poEBVaUxAzJBEaMaBrZKLVer1zXaNNYfxg,12851
+sqlobjects-1.9.1.data/data/share/sqlobjects/rules/README.md,sha256=d2n5ZZT8LGvjL60u_HlzXn2uA8FwoCgqG3fuAhvMFvM,2280
+sqlobjects-1.9.1.dist-info/licenses/LICENSE,sha256=ScFR7nvWIhar0d32Y-LA4vqp9zNmy1HSJia7UX7jU6c,1068
+sqlobjects-1.9.1.dist-info/METADATA,sha256=hwm-cigR9lOxRkbN9L66dMxdKp9vc4gJGU1GNUGKHlw,13740
+sqlobjects-1.9.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+sqlobjects-1.9.1.dist-info/entry_points.txt,sha256=9Q3Ci55MawxkQhMlR_eLJui00_rYYIVO_Aq_Dm0u5MQ,76
+sqlobjects-1.9.1.dist-info/top_level.txt,sha256=brO5vDtCpn4L9dpX0EHpehbu4kcHaK_2Bbnwze35YKc,11
+sqlobjects-1.9.1.dist-info/RECORD,,