melexis/sphinx-traceability-extension

View on GitHub
mlx/traceability/traceable_base_class.py

Summary

Maintainability
A
0 mins
Test Coverage

Use of insecure MD2, MD4, MD5, or SHA1 hash function.
Open

            data['content-hash'] = hashlib.md5(self.content.encode('utf-8')).hexdigest()

Too many instance attributes (10/7)
Open

class TraceableBaseClass:

Used when class has too many instance attributes, try to reduce this to get a simpler (and so easier to use) class.

Formatting a regular string which could be a f-string
Open

            raise ValueError('Update error {old} vs {new}'.format(old=self.identifier, new=other.identifier))

Used when we detect a string that is being formatted with format() or % which could potentially be a f-string. The use of f-strings is preferred. Requires Python 3.6 and py-version >= 3.6.

Missing function or method docstring
Wontfix

    def content(self):

Used when a function or method has no docstring. Some special methods like init do not require a docstring.

Formatting a regular string which could be a f-string
Open

            raise TraceabilityException("Item '{identification}' has no reference to source document."

Used when we detect a string that is being formatted with format() or % which could potentially be a f-string. The use of f-strings is preferred. Requires Python 3.6 and py-version >= 3.6.

There are no issues that match your filters.

Category
Status