Skip to content

chore: updated imports to use absolute paths#42

Merged
petruki merged 4 commits intomasterfrom
staging
Mar 15, 2026
Merged

chore: updated imports to use absolute paths#42
petruki merged 4 commits intomasterfrom
staging

Conversation

@petruki
Copy link
Member

@petruki petruki commented Mar 15, 2026

This pull request introduces several improvements and fixes across the codebase, focusing on code quality, documentation, and consistency. The main changes include enhanced docstrings for better code clarity, correction of import paths to use absolute imports, fixing a typo in an exception name, and various project metadata updates.

Key changes:

1. Code Quality and Documentation Improvements

  • Added or improved docstrings for core classes and methods, such as Client, GlobalAuth, GlobalSnapshot, RetryOptions, Remote, RemoteAuth, Resolver, ResultDetail, and others to clarify their purpose and usage. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]

2. Import Path Consistency

  • Refactored all relative imports to use absolute imports with the switcher_client prefix across all modules for improved clarity and compatibility. [1] [2] [3] [4] [5] [6] [7] [8]

3. Exception Naming Fixes and Enhancements

  • Fixed a typo in the exception name from SnapshpotNotFoundError to SnapshotNotFoundError throughout the codebase. [1] [2] [3] [4]
  • Added docstrings to all custom exception classes for better error context.

4. Project Metadata and Configuration Updates

  • Updated pyproject.toml with version, description, license, readme, Python version requirements, classifiers, and URLs to improve packaging and distribution metadata.
  • Updated SonarQube project version to 0.1.0 in sonar-project.properties.
  • Simplified and updated .vscode/settings.json for better linting and environment management.
  • Adjusted pylint configuration to re-enable some docstring checks and clean up disables.

5. Minor Codebase Cleanups

  • Combined pylint disables into a single line for readability.
  • Added clarifying comments and improved function docstrings in strategy and operation processing. [1] [2]

These changes collectively improve the maintainability, clarity, and usability of the codebase.

@petruki petruki self-assigned this Mar 15, 2026
@petruki petruki added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 15, 2026
@sonarqubecloud
Copy link

@petruki petruki merged commit 1cd0dda into master Mar 15, 2026
15 checks passed
@petruki petruki deleted the staging branch March 15, 2026 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant