fix: ModuleNotFoundError when CMS is not installed

[fsbraun]

Fixes #55

Summary by Sourcery

Bug Fixes:

• Fixed a ModuleNotFoundError that occurred when the CMS was not installed.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request fixes a ModuleNotFoundError that occurs when django CMS is not installed. The fix involves adding a check to ensure that the 'cms' app is in the INSTALLED_APPS setting before attempting to import or use any CMS-related functionality. Additionally, type hints were added to improve code readability and maintainability.

Class diagram showing TextConfig and related functions with type hints

classDiagram
    class TextConfig {
        +str name
        +str verbose_name
        +str default_auto_field
        +dict[str, str] inline_models
        +ready()
    }

    class Functions {
        +discover_inline_editable_models() dict[str, str]
        +check_ckeditor_settings(app_configs, kwargs) list
        +check_no_cms_config(app_configs, kwargs) list
    }

    note for TextConfig "Added type hint for inline_models"
    note for Functions "Added return type hints to functions"

Loading

File-Level Changes

Change	Details	Files
Added type hints to improve code readability and maintainability.	Added type hint for inline_models in TextConfig. Added return type hint for discover_inline_editable_models. Added return type hint for check_ckeditor_settings. Added return type hint for check_no_cms_config. Added type hint for inline_models in discover_inline_editable_models. Added type hint for blacklist_apps in discover_inline_editable_models. Added type hint for warnings in check_ckeditor_settings.	djangocms_text/apps.py
Added a check to prevent ModuleNotFoundError when CMS is not installed.	Added a conditional check to ensure that 'cms' is in settings.INSTALLED_APPS before proceeding with CMS-related logic in check_no_cms_config.	djangocms_text/apps.py

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#55	Resolve the import error when using HTMLField in projects without django CMS installed	✅
#55	Ensure the djangocms_text package can be used without requiring django CMS to be installed	✅

Possibly linked issues

• Import error when using in projects without django CMS #55: This PR fixes the mentioned issue.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @fsbraun - I've reviewed your changes - here's some feedback:

Overall Comments:

• Could you please explain in the PR description how these type annotation changes fix the ModuleNotFoundError mentioned in the title? This would help document the connection between the changes and issue Import error when using in projects without django CMS #55.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codecov]

Codecov Report

Attention: Patch coverage is 58.33333% with 5 lines in your changes missing coverage. Please review.

Project coverage is 80.89%. Comparing base (223150b) to head (4bb09d5).

Files with missing lines	Patch %	Lines
djangocms_text/utils.py	37.50%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #56      +/-   ##
==========================================
- Coverage   81.28%   80.89%   -0.40%     
==========================================
  Files          17       17              
  Lines         935      942       +7     
  Branches      104      104              
==========================================
+ Hits          760      762       +2     
- Misses        132      137       +5     
  Partials       43       43              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.