:class:`Security` ================= .. py:class:: src.ansys.pre_commit_hooks.quality_rules.security.Security Bases: :py:obj:`abc.ABC` Security rule family. Base class of the security quality rules. Each rule is a subclass named ``SEC`` with a static ``check`` method that evaluates one security control of the repository independently. .. !! processed by numpydoc !! .. py:currentmodule:: Security Overview -------- .. tab-set:: .. tab-item:: Abstract methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~check` - Evaluate a security rule. .. tab-item:: Attributes .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~family` - Import detail ------------- .. code-block:: python from src.ansys.pre_commit_hooks.quality_rules.security import Security Attribute detail ---------------- .. py:attribute:: family :type: ClassVar[str] :value: 'security' Method detail ------------- .. py:method:: check(repository_root: pathlib.Path, readme_file: str | None) -> ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult :staticmethod: :abstractmethod: Evaluate a security rule. :Parameters: **repository_root** : :obj:`pathlib.Path` Repository root directory. **readme_file** : :class:`python:str` or :data:`python:None` Detected README path, unused by this rule family. :Returns: :ref:`bool ` or :class:`python:str` ``True`` when the rule passes, ``False`` for an error, or a string prefixed with ``"RECOMMENDATION: "``, ``"WARNING: "``, or ``"ERROR: "``. .. !! processed by numpydoc !!