Deprecate the ~log table.. Improve code organization: docstrings, type hints, and imports. #1297
+680
−389
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add module docstrings to cli.py, admin.py, logging.py, and hash.py - Add `from __future__ import annotations` for PEP 563 deferred evaluation - Modernize type hints using Python 3.10+ syntax (X | None instead of Optional[X]) - Use TYPE_CHECKING imports to avoid circular dependencies - Improve function docstrings to Google style with Args/Returns sections - Add type annotations to key public APIs in: - connection.py: Connection class and conn() function - fetch.py: Fetch and Fetch1 classes - expression.py: QueryExpression class properties and methods - utils.py: utility functions - hash.py: hashing functions - admin.py: kill() and kill_quick() functions
- Add module docstrings to cli.py, admin.py, logging.py, and hash.py - Add `from __future__ import annotations` for PEP 563 deferred evaluation - Modernize type hints using Python 3.10+ syntax (X | None instead of Optional[X]) - Use TYPE_CHECKING imports to avoid circular dependencies - Improve function docstrings to Google style with Args/Returns sections - Add type annotations to: - admin.py: set_password(), kill(), and kill_quick() functions - cli.py: cli() function - hash.py: all hashing functions - logging.py: excepthook() function - utils.py: all utility functions and ClassProperty Co-authored-by: dimitri-yatsenko <dimitri@datajoint.com>
…ew-code-organization-9135z Merges restructured project with src/datajoint/ layout and code organization improvements including docstrings, type hints, and modern Python 3.10+ features. Co-authored-by: dimitri-yatsenko <dimitri@datajoint.com>
dimitri-yatsenko
force-pushed
the
claude/review-code-organization-9135z
branch
from
90a1b71 to
4eb8202
Compare
dimitri-yatsenko
changed the title
Closes #1298 The ~log table is a client-side audit logging mechanism that has been superseded by modern alternatives including: - Server-side database audit logging - Infrastructure logging platforms (Datadog, CloudWatch) - Python's standard logging module Changes: - Remove Log class from table.py - Remove log property from Schema class - Replace self._log() calls with logger.info/debug - Remove special ~log handling from heading.py - Delete test_log.py Existing ~log tables in databases remain but will no longer be written to. All operations now emit through Python's logging module instead. Co-authored-by: dimitri-yatsenko <dimitri@datajoint.com>
The package was moved to src/datajoint/ but these files remained as orphans after the merge. Removing to avoid confusion. Co-authored-by: dimitri-yatsenko <dimitri@datajoint.com>
dimitri-yatsenko
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #1298 - Deprecate the
~logtable.from __future__ import annotationsfor PEP 563 deferred evaluation