feat: [FC-0074] use linter for openedx-filters classes definitions

[mariajgrimaldi]

Description

This PR adds a new custom Pylint linter to check whether filter definitions docstrings follow a specific format:

        ...
        Purpose:
        ... (purpose)
        Filter Type:
            org.openedx.learning.certificate.render.started.v1
        Trigger:
            - Repository: openedx/edx-platform
            - Path: lms/djangoapps/certificates/views/webview.py
            - Function or Method: render_html_view

Proposed in docs/reference/documenting-filters-classes.rst. The purpose of this linter is to establish a standard for developers to follow when documenting filter classes in the repository.

This PR is a continuation of #246, which enforces the format introduced in the PR.

Testing instructions

1. Move to this branch
2. Create a new filter (a dummy one) following the proposed format for the classes' docstring, then run pylint openedx_filters/learning/filters.py

class MyFilter(OpenEdxPublicFilter):
    """
    Generic filter used to modify a field based on the provided filter type.

    Purpose:
        This filter is triggered when a specific event occurs, allowing the filter to modify the field based on the
        provided filter type.

    Filter Type:
        org.openedx.my_filter.v1

    Trigger:
        - Repository: openedx/edx-platform
        - Path: path/to/file.py
        - Function or Method: my_function
    """

    filter_type = "org.openedx.my_filter.v1"

    @classmethod
    def run_filter(cls, my_field: str) -> tuple[str]:
        """
        Process the inputs using the configured pipeline steps to modify the field based on the provided filter type.

        Arguments:
            - my_field (str): the field to be modified.

        Returns:
            tuple[str, str]:
                - str: the modified field.
                - str: the context.
        """
        data = super().run_pipeline(my_field=my_field)
        return data.get("my_field")

3. Remove a section and review the output of pylint openedx_filters/learning/filters.py once again.

Deadline

None

Other information

This PR depends on openedx/edx-lint#480 and #246

Checklists

Check off if complete or not applicable:

Merge Checklist:

• All reviewers approved
• Reviewer tested the code following the testing instructions
• CI build is green
• Version bumped
• Changelog record added with short description of the change and current date
• Documentation updated (not only docstrings)
• Code dependencies reviewed
• Fixup commits are squashed away
• Unit tests added/updated
• Noted any: Concerns, dependencies, migration issues, deadlines, tickets

Post Merge:

• Create a tag
• Create a release on GitHub
• Check new version is pushed to PyPI after tag-triggered build is
  finished.
• Delete working branch (if not needed anymore)
• Upgrade the package in the Open edX platform requirements (if applicable)

[openedx-webhooks]

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/hooks-extension-framework.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

---

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[mariajgrimaldi]

I'll merge this PR is merged and a new version of is released: openedx/edx-lint#480

[BryanttV]

Hi @mariajgrimaldi, I was testing and the linter works awesome! I just have a comment about the docs. Thanks!

[BryanttV]

I think we should mention that if the filters are not triggered yet, we can use NA.

[mariajgrimaldi]

Great idea! Thanks for the suggestion

[mariajgrimaldi]

Addressed: 39d0a63