Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev cosinemudbox #16

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Dev cosinemudbox #16

wants to merge 2 commits into from

Conversation

erichilarysmithsr
Copy link
Contributor

No description provided.

@erichilarysmithsr erichilarysmithsr added the enhancement New feature or request label Feb 29, 2024
@erichilarysmithsr erichilarysmithsr self-assigned this Feb 29, 2024
Copy link

codesandbox bot commented Feb 29, 2024

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Type: Enhancement

PR Summary: This pull request introduces a new Python module, actionNameTypes.py, which defines a series of data classes intended to model inputs and outputs for various API endpoints, leveraging the dataclass decorator for boilerplate reduction. Additionally, it includes a mixin class, RequestMixin, to facilitate serialization and deserialization of these data classes from and to JSON, respectively. A settings.py file is also added to configure Sentry SDK for error tracking.

Decision: Comment

📝 Type: 'Enhancement' - not supported yet.
  • Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
✅ Small diff: the diff is small enough to approve with confidence.
No details provided.

General suggestions:

  • Consider refining the use of type hints across the data classes. The use of Optional[Any] is too broad and diminishes the benefits of static type checking. Specifying more precise types would improve code clarity and reliability.
  • Ensure that the Sentry SDK configuration in settings.py follows best practices for security, particularly regarding the exposure of the DSN.
  • Review the PR title and description to ensure they accurately reflect the changes made and the impact on the project. The current title 'Dev cosinemudbox' could be more descriptive regarding the nature of the enhancements.

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

Comment on lines +18 to +19
locationId: Optional[Any]
object: Optional[QOLocationsFictionalSetInputInput]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (llm): Using Any as a type hint for locationId and other fields across multiple data classes reduces the benefits of type checking. Consider specifying a more precise type if possible, such as int or str, to enhance code clarity and reliability.

Comment on lines +6 to +7
dsn="https://debb7902c3784d12b622c768f7ebf8ad@o229048.ingest.sentry.io/6755743",
)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚨 security (llm): Hard-coded Sentry DSN found. It's recommended to use environment variables or configuration files that are not checked into version control for sensitive information like DSNs. This prevents the risk of exposing such information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant