Refactor and Improve Type Hints, Clean Up Code, and Remove requests Attribute from StatusData #12

robert-nogueira · 2025-04-14T20:59:42Z

Changelog

Chores

🧹 chore(py.typed): Add py.typed file to indicate the package supports type hints. ([38d4e86](robert-nogueira@38d4e86))
🧹 chore(data.py): Clean up unused code and improve type hint formatting. ([926026b](robert-nogueira@926026b))
🧹 chore(pyporject.toml): Update dependencies, Python version, and tooling for improved development, linting, and security. ([391f86b](robert-nogueira@391f86b))
🧹 chore(safety-project.ini): Add .safety-project.ini configuration file to define project metadata for safety checks. ([ee37f1d](robert-nogueira@ee37f1d))

Tests

✅ test(tests): Standardize quotes, clean up imports, and update dict syntax.
- Replaced single quotes with double quotes for consistency.
- Removed unused import statements.
- Updated dictionary keys and values to use double quotes. ([f01b2d0](robert-nogueira@f01b2d0))
🧪 Refactor tests and improve type annotations. ([cd99c5f](robert-nogueira@cd99c5f))

Styles

🎨 style(client.py): Standardize string quotes from single to double for consistency across the file. ([aded547](robert-nogueira@aded547))
🎨 style(style): Update parameter names from __kwargs to _kwargs for consistency and readability. ([576e8c1](robert-nogueira@576e8c1))

Refactors

🗑️ delete examples/app_data. ([6cb1b41](robert-nogueira@6cb1b41))
🩹 Fix parameter name inconsistency in RequestListenerManager. ([adcdff0](robert-nogueira@adcdff0))
♻️ Refactor data classes to use custom metaclass for immutability. ([634e8cb](robert-nogueira@634e8cb))
♻️ Refactor Client class methods and improve typings. ([a1e3136](robert-nogueira@a1e3136))
♻️ Refactor typing and improve function signatures in Application class. ([9b95733](robert-nogueira@9b95733))

Enhancements

✨ Enhance typing and improve script clarity. ([fd6b17d](robert-nogueira@fd6b17d))

Documentation

🏷️ Improved typing and sorted imports. ([c06955c](robert-nogueira@c06955c))
📚 Improved examples. ([77de002](robert-nogueira@77de002))

BREAKING CHANGES

🧹 chore(data.py): Removed the requests attribute from StatusData. ([926026be](robert-nogueira@926026be))

- Introduced type variables for better type hinting (zsh: command not found: T, zsh: command not found: AsyncCallable). - Updated method signatures to use specific types instead of forward declarations (zsh: command not found: Client). - Enhanced decorator typings to accept async functions with appropriate return types. - Removed deprecated zsh: command not found: data method and applied decorators to zsh: command not found: logs method. - Added return type annotations for several async methods (e.g., zsh: command not found: set_custom_domain, zsh: command not found: all_backups).

- Renamed zsh: command not found: extra to zsh: command not found: extra_value in notifications for consistency. - Removed the commented-out zsh: command not found: app_backups method and the deprecated zsh: command not found: app_data method. - Refactored app data handling in zsh: command not found: get_app_data to simplify language handling. - Updated method signatures to reflect accurate return types and removed unnecessary comments. - Cleaned up zsh: command not found: last_deploys method to ensure better clarity and maintainability.

- Replaced decorator with a custom metaclass zsh: command not found: DataClasMeta for better flexibility and control. - Renamed zsh: command not found: language field to zsh: command not found: lang in zsh: command not found: AppData and zsh: command not found: StatusData for consistency. - Removed unused zsh: command not found: requests field in zsh: command not found: StatusData. - Simplified class inheritance structure for better readability and maintainability.

- Changed zsh: command not found: extra_value back to zsh: command not found: extra in the zsh: command not found: RequestListenerManager class to maintain consistency with the rest of the codebase.

- Added explicit return types for zsh: command not found: run_async_script and zsh: command not found: delete_test_apps. - Updated type hints in zsh: command not found: run_async_script for better typing consistency. - Fixed emoji code formatting in zsh: command not found: delete_test_apps print statements.

- Add precise type annotations to fixtures in zsh: command not found: conftest.py - Use zsh: command not found: AsyncGenerator in zsh: command not found: app fixture for clarity - Remove unused test cases: zsh: command not found: test_app_data and zsh: command not found: test_request_app_data - Standardize zsh: command not found: @pytest.mark.skipif formatting - Enhance test readability and streamline coverage

…le to define project metadata for safety checks

…ling for improved development, linting, and security - Updated Python requirement to 3.13 - Updated dependencies for better compatibility - Added Bandit configuration for security checks - Included 'ruff check .' in the lint command - Fixed package inclusion quotes for consistency

…onsistency and readability

…or consistency across the file

- Removed unused 'requests' variable from StatusData - Reformatted type hints in deviceTypes and operatingSystems for better readability

…syntax >>> ⏰ - Replaced single quotes with double quotes for consistency - Removed unused import statements - Updated dictionary keys and values to use double quotes

… type hints

…i SDK from README to streamline documentation

Copilot

Copilot reviewed 72 out of 73 changed files in this pull request and generated 17 comments.

Files not reviewed (1)

.safety-project.ini: Language not supported

examples/deleting_application/with_application.py

examples/delete_file/with_client.py

examples/delete_file/with_application.py

examples/custom_domain/with_client.py

examples/custom_domain/with_application.py

examples/backup/with_application.py

examples/app_cache/update_cache.py

examples/app_cache/clear_cache.py

examples/app_cache/avoid_update_cache.py

examples/app_cache/accessing_application_cache.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

robert-nogueira added 17 commits November 11, 2024 10:42

📚 Improved examples

77de002

🏷️ improved typing and sort imports

c06955c

🩹 Fix parameter name inconsistency in RequestListenerManager

adcdff0

- Changed zsh: command not found: extra_value back to zsh: command not found: extra in the zsh: command not found: RequestListenerManager class to maintain consistency with the rest of the codebase.

🗑️ deleted examples/app_data

6cb1b41

🧹 chore(safety-project.ini): add .safety-project.ini configuration fi…

ee37f1d

…le to define project metadata for safety checks

🎨 style(style): update parameter names from __kwargs to _kwargs for c…

576e8c1

…onsistency and readability

🎨 style(client.py): standardize string quotes from single to double f…

aded547

…or consistency across the file

🧹 chore(data.py): clean up unused code and improve type hint formatting

926026b

- Removed unused 'requests' variable from StatusData - Reformatted type hints in deviceTypes and operatingSystems for better readability

✅ test(tests): standardize quotes, clean up imports, and update dict …

f01b2d0

…syntax >>> ⏰ - Replaced single quotes with double quotes for consistency - Removed unused import statements - Updated dictionary keys and values to use double quotes

🧹 chore(py.typed): add py.typed file to indicate the package supports…

38d4e86

… type hints

chore(docs): remove pipx installation instructions for squarecloud-ap…

419c3b3

…i SDK from README to streamline documentation

JoaoOtavioS requested a review from Copilot April 16, 2025 06:10

Copilot AI reviewed Apr 16, 2025

View reviewed changes

JoaoOtavioS and others added 11 commits April 16, 2025 12:49

Update examples/deleting_application/with_application.py

0f0f6bf

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/delete_file/with_client.py

4994926

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/delete_file/with_application.py

7437511

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/custom_domain/with_application.py

9819b8d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/custom_domain/with_client.py

c12a1a9

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/backup/with_application.py

525d655

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/app_cache/clear_cache.py

3281b1c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/app_cache/avoid_update_cache.py

97e822d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/app_cache/update_cache.py

e048b46

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/app_cache/accessing_application_cache.py

bf0bd84

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/create_file/with_client.py

35fdc60

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

JoaoOtavioS and others added 6 commits April 16, 2025 12:50

Update examples/create_file/with_application.py

e39c988

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/commit/with_client.py

88c29b6

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/commit/with_application.py

bcce120

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/client_example.py

85f39c3

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/capture_listener.py

4b35a4a

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update examples/backup/with_client.py

a9f6fed

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

JoaoOtavioS merged commit 420a56f into squarecloudofc:main Apr 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refactor and Improve Type Hints, Clean Up Code, and Remove requests Attribute from StatusData #12

Refactor and Improve Type Hints, Clean Up Code, and Remove requests Attribute from StatusData #12

Uh oh!

robert-nogueira commented Apr 14, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Refactor and Improve Type Hints, Clean Up Code, and Remove requests Attribute from StatusData #12

Refactor and Improve Type Hints, Clean Up Code, and Remove requests Attribute from StatusData #12

Uh oh!

Conversation

robert-nogueira commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Chores

Tests

Styles

Refactors

Enhancements

Documentation

BREAKING CHANGES

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

robert-nogueira commented Apr 14, 2025 •

edited

Loading