diff options
author | Daniƫl van Noord <13665637+DanielNoord@users.noreply.github.com> | 2022-03-24 16:37:04 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-03-24 16:37:04 +0100 |
commit | a5a5701095f51c3127873fa4f55e9a1ca1438cb2 (patch) | |
tree | c951ad3b46880692af506ce51c2309ae2e00e0ae /doc | |
parent | fd91d04a2f946c6fe8b31b6f9217a61caab55c7d (diff) | |
download | pylint-git-a5a5701095f51c3127873fa4f55e9a1ca1438cb2.tar.gz |
Add documentation for abstract-method and abstract-class-instantiated (#5957)
Co-authored-by: Vladyslav Krylasov <vladyslav.krylasov@gmail.com>
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/data/messages/a/abstract-class-instantiated/bad.py | 10 | ||||
-rw-r--r-- | doc/data/messages/a/abstract-class-instantiated/good.py | 15 | ||||
-rw-r--r-- | doc/data/messages/a/abstract-method/bad.py | 20 | ||||
-rw-r--r-- | doc/data/messages/a/abstract-method/good.py | 22 |
4 files changed, 67 insertions, 0 deletions
diff --git a/doc/data/messages/a/abstract-class-instantiated/bad.py b/doc/data/messages/a/abstract-class-instantiated/bad.py new file mode 100644 index 000000000..f514a5c3d --- /dev/null +++ b/doc/data/messages/a/abstract-class-instantiated/bad.py @@ -0,0 +1,10 @@ +import abc + + +class Animal(abc.ABC): + @abc.abstractmethod + def make_sound(self): + pass + + +sheep = Animal() # [abstract-class-instantiated] diff --git a/doc/data/messages/a/abstract-class-instantiated/good.py b/doc/data/messages/a/abstract-class-instantiated/good.py new file mode 100644 index 000000000..c9dbce107 --- /dev/null +++ b/doc/data/messages/a/abstract-class-instantiated/good.py @@ -0,0 +1,15 @@ +import abc + + +class Animal(abc.ABC): + @abc.abstractmethod + def make_sound(self): + pass + + +class Sheep(Animal): + def make_sound(self): + print("bhaaaaa") + + +sheep = Sheep() diff --git a/doc/data/messages/a/abstract-method/bad.py b/doc/data/messages/a/abstract-method/bad.py new file mode 100644 index 000000000..8b8ddf0f9 --- /dev/null +++ b/doc/data/messages/a/abstract-method/bad.py @@ -0,0 +1,20 @@ +class Pet: + def make_sound(self): + raise NotImplementedError + + +class Cat(Pet): # [abstract-method] + pass + + +import abc + + +class WildAnimal: + @abc.abstractmethod + def make_sound(self): + pass + + +class Panther(WildAnimal): # [abstract-method] + pass diff --git a/doc/data/messages/a/abstract-method/good.py b/doc/data/messages/a/abstract-method/good.py new file mode 100644 index 000000000..4c4cda3f4 --- /dev/null +++ b/doc/data/messages/a/abstract-method/good.py @@ -0,0 +1,22 @@ +class Pet: + def make_sound(self): + raise NotImplementedError + + +class Cat(Pet): + def make_sound(self): + print("Meeeow") + + +import abc + + +class WildAnimal: + @abc.abstractmethod + def make_sound(self): + pass + + +class Panther(WildAnimal): + def make_sound(self): + print("MEEEOW") |