Release 0.9.0

Author: kalekseev

CHANGELOG.md

@@ -2,10 +2,17 @@
 
 ### Unreleased
 
+### 0.9.0
+
+- Disable checks with `extra-checks-disable-next-line` comment
+- Deprecate `@ignore_checks`
+- Make ast parsing lazy
+- Add global log level
+
 ### 0.8.0
 
 - Add checks:
-    - `field-choices-constraint`
+  - `field-choices-constraint`
 
 ### 0.7.1
 
@@ -15,13 +22,13 @@
 
 - Check `field-foreign-key-index` now accepts `when: indexes` instead of `when: unique_toegether` because now it search for duplicate indexes in `Meta.indexes`, `Meta.unique_toegether` and `Meta.constraints`
 - Add checks:
-    - `no-unique-together`
-    - `no-index-together`
+  - `no-unique-together`
+  - `no-index-together`
 
 ### 0.6.0
 
 - Add checks:
-    - `field-default-null`
+  - `field-default-null`
 
 ### 0.5.0
 
@@ -37,9 +44,9 @@
 
 - Add infra for rest framework serializers checks
 - Add checks:
-    - `drf-model-serializer-extra-kwargs`
-    - `drf-model-serializer-meta-attribute`
-    - `model-admin`
+  - `drf-model-serializer-extra-kwargs`
+  - `drf-model-serializer-meta-attribute`
+  - `model-admin`
 
 ### 0.3.0
 

README.md

@@ -33,14 +33,21 @@ EXTRA_CHECKS = {
 
 #### Ignoring check problems
 
-To ignore all warnings on some object you can use `ignore_checks` decorator:
+Use `extra-checks-disable-next-line` comment to disable checks:
 
 ```python
-from extra_checks import ignore_checks, CheckID
-
-@ignore_checks("model-attribute", "X011", CheckID.X050)
+# disable specific checks on model
+# extra-checks-disable-next-line model-attribute, model-admin
 class MyModel(models.Model):
+    # disable all checks on image field
+    # extra-checks-disable-next-line
     image = models.ImageField()
+
+    # separate comments and check's codes are aslo supported
+    # extra-checks-disable-next-line X014
+    # extra-checks-disable-next-line no-unique-together
+    class Meta:
+        ...
 ```
 
 Another way is to specify type of the object that need to be ignored in `ignore_types` option:
@@ -77,10 +84,10 @@ EXTRA_CHECKS = {
 - **field-null** - don't pass `null=False` to model fields (this is django default).
 - **field-foreign-key-db-index** - ForeignKey fields must specify `db_index` explicitly (to apply only to fields in indexes: `when: indexes`).
 - **field-default-null** - If field nullable (`null=True`), then
-    `default=None` argument is redundant and should be removed.
-    **WARNING** Be aware that setting is database dependent,
-    eg. Oracle interprets empty strings as nulls as a result
-    django uses empty string instead of null as default.
+  `default=None` argument is redundant and should be removed.
+  **WARNING** Be aware that setting is database dependent,
+  eg. Oracle interprets empty strings as nulls as a result
+  django uses empty string instead of null as default.
 - **field-choices-constraint** - Fields with choices must have companion CheckConstraint to enforce choices on database level, [details](https://adamj.eu/tech/2020/01/22/djangos-field-choices-dont-constrain-your-data/).
 
 ### DRF Serializers

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = django-extra-checks
-version = 0.8.0
+version = 0.9.0
 author = Konstantin Alekseev
 author_email = [email protected]
 description = Collection of useful checks for Django Checks Framework

src/extra_checks/registry.py

@@ -144,7 +144,7 @@ def is_healthy(self) -> bool:
     def ignore_checks(self, *args: Union[CheckId, str]) -> Callable[[Any], Any]:
         checks = ", ".join([c.value if isinstance(c, CheckId) else c for c in args])
         warnings.warn(
-            f'@ignore_checks is deprecated and will be removed in version 0.10.0, replace it with comment "# extra-checks-disable-next-line {checks}"',
+            f'@ignore_checks is deprecated and will be removed in version 0.11.0, replace it with comment "# extra-checks-disable-next-line {checks}"',
             DeprecationWarning,
         )
 

tests/example/models.py

@@ -212,7 +212,7 @@ class DisableManyChecksModel(models.Model):
     text_fail2 = models.TextField(null=True)
 
     # disable two checks with separate comments
-    # extra-checks-disable-next-line no-index-together
+    # extra-checks-disable-next-line X014
     # extra-checks-disable-next-line no-unique-together
     class Meta:
         unique_together = ("text_fail", "text_fail2")