path: root/python-pylint-enums.spec

%global _empty_manifest_terminate_build 0
Name:		python-pylint-enums
Version:	0.0.5
Release:	1
Summary:	A Pylint plugin that checks for a specific implementation of Enum subclasses.
License:	MIT License
URL:		https://github.com/cs-cordero/pylint_enums
Source0:	https://mirrors.aliyun.com/pypi/web/packages/d0/98/0cefde3c334f7000b1b9faec113db958e8368da82043d7818a2d4d86df14/pylint_enums-0.0.5.tar.gz
BuildArch:	noarch

Requires:	python3-pylint

%description
# Pylint-Enums

## Installation:

```
$ pip install pylint_enums     # a conventional option
$ pipenv install pylint_enums  # a more modern option
```

## Usage:
- Follow instructions to add `pylint_enums` as part of your loaded plugins.
    - Option 1 (.pylintrc)
        - Add `load-plugins=pylint_enums` to your `.pylintrc`.
        - Use pylint normally, i.e., `$ pylint [filepath]`
    - Option 2 (command line option)
        - `$ pylint [filepath] --load-plugins=pylint_enums`

## What this is:

This is a tiny pylint plugin that adds a checker for Enum subclasses.  It warns you when you haven't provided a typed annotation for the `value` attribute and when a `__str__` method has not been defined for the Enum when the type annotation isn't part of a finite list of simple types.

`__str__` declaration is not enforced for the following types:
* `str`
* `int`
* `decimal`
* `float`

## Why this is helpful:

Typically, the value of an enum doesn't matter.

```
from enum import Enum

class Foo(Enum):
    FIRST = 'these'
    SECOND = 'usually'
    THIRD = 'don\'t'
    FOURTH = 'matter'
```

However, in certain applications and/or use-cases, you actually do care about the value of each enum member.  Specifically, you may use them as a `verbose_name` or a `pretty_name` for displaying to the user, or you may want to assign it a stateful value and use its contents later.

```
from enum import Enum
from typing import NamedTuple

class FooMember(NamedTuple):
    label: str
    rank: int

class Foo(Enum):
    FIRST = FooMember(label='first', rank=1)
    SECOND = FooMember(label='second', rank=2)
    THIRD = FooMember(label='third', rank=3)
    FOURTH = FooMember(label='fourth', rank=4)

    def __str__(self) -> str:
        return self.value.label
```

As of this writing, `mypy==0.600` is unable to infer the types of the member values. They resolve to `'Any'`:

```
reveal_type(Foo)             # 'def (value: Any) -> foo.Foo'
reveal_type(Foo.FIRST)       # 'foo.Foo'
reveal_type(Foo.FIRST.value) # 'Any'
```

This can be problematic for `mypy` users that rely on type hints to maintain their code base.  When you write a function that returns `Foo.FIRST.value`, our tooling is unable to help us figure out whether this value is a `str`, a `NamedTuple`, or some other value.  Ideally, we would add additional type hints to the Enum:

```
class Foo(Enum):
    value: FooMember
    FIRST = FooMember(label='first', rank=1)
    ...
```

But alas, this requires developer vigilance to remember to do.  If you're maintaining many enums across multiple files, it could be annoying to make sure that they and all future defined Enums are adequately typed.

This pylint plugin will raise errors when `value` is not typed and when the value is typed to something complex and the Enum is missing a `__str__` method.

## Author

[Christopher Sabater Cordero](https://github.com/cs-cordero)




%package -n python3-pylint-enums
Summary:	A Pylint plugin that checks for a specific implementation of Enum subclasses.
Provides:	python-pylint-enums
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-pylint-enums
# Pylint-Enums

## Installation:

```
$ pip install pylint_enums     # a conventional option
$ pipenv install pylint_enums  # a more modern option
```

## Usage:
- Follow instructions to add `pylint_enums` as part of your loaded plugins.
    - Option 1 (.pylintrc)
        - Add `load-plugins=pylint_enums` to your `.pylintrc`.
        - Use pylint normally, i.e., `$ pylint [filepath]`
    - Option 2 (command line option)
        - `$ pylint [filepath] --load-plugins=pylint_enums`

## What this is:

This is a tiny pylint plugin that adds a checker for Enum subclasses.  It warns you when you haven't provided a typed annotation for the `value` attribute and when a `__str__` method has not been defined for the Enum when the type annotation isn't part of a finite list of simple types.

`__str__` declaration is not enforced for the following types:
* `str`
* `int`
* `decimal`
* `float`

## Why this is helpful:

Typically, the value of an enum doesn't matter.

```
from enum import Enum

class Foo(Enum):
    FIRST = 'these'
    SECOND = 'usually'
    THIRD = 'don\'t'
    FOURTH = 'matter'
```

However, in certain applications and/or use-cases, you actually do care about the value of each enum member.  Specifically, you may use them as a `verbose_name` or a `pretty_name` for displaying to the user, or you may want to assign it a stateful value and use its contents later.

```
from enum import Enum
from typing import NamedTuple

class FooMember(NamedTuple):
    label: str
    rank: int

class Foo(Enum):
    FIRST = FooMember(label='first', rank=1)
    SECOND = FooMember(label='second', rank=2)
    THIRD = FooMember(label='third', rank=3)
    FOURTH = FooMember(label='fourth', rank=4)

    def __str__(self) -> str:
        return self.value.label
```

As of this writing, `mypy==0.600` is unable to infer the types of the member values. They resolve to `'Any'`:

```
reveal_type(Foo)             # 'def (value: Any) -> foo.Foo'
reveal_type(Foo.FIRST)       # 'foo.Foo'
reveal_type(Foo.FIRST.value) # 'Any'
```

This can be problematic for `mypy` users that rely on type hints to maintain their code base.  When you write a function that returns `Foo.FIRST.value`, our tooling is unable to help us figure out whether this value is a `str`, a `NamedTuple`, or some other value.  Ideally, we would add additional type hints to the Enum:

```
class Foo(Enum):
    value: FooMember
    FIRST = FooMember(label='first', rank=1)
    ...
```

But alas, this requires developer vigilance to remember to do.  If you're maintaining many enums across multiple files, it could be annoying to make sure that they and all future defined Enums are adequately typed.

This pylint plugin will raise errors when `value` is not typed and when the value is typed to something complex and the Enum is missing a `__str__` method.

## Author

[Christopher Sabater Cordero](https://github.com/cs-cordero)




%package help
Summary:	Development documents and examples for pylint-enums
Provides:	python3-pylint-enums-doc
%description help
# Pylint-Enums

## Installation:

```
$ pip install pylint_enums     # a conventional option
$ pipenv install pylint_enums  # a more modern option
```

## Usage:
- Follow instructions to add `pylint_enums` as part of your loaded plugins.
    - Option 1 (.pylintrc)
        - Add `load-plugins=pylint_enums` to your `.pylintrc`.
        - Use pylint normally, i.e., `$ pylint [filepath]`
    - Option 2 (command line option)
        - `$ pylint [filepath] --load-plugins=pylint_enums`

## What this is:

This is a tiny pylint plugin that adds a checker for Enum subclasses.  It warns you when you haven't provided a typed annotation for the `value` attribute and when a `__str__` method has not been defined for the Enum when the type annotation isn't part of a finite list of simple types.

`__str__` declaration is not enforced for the following types:
* `str`
* `int`
* `decimal`
* `float`

## Why this is helpful:

Typically, the value of an enum doesn't matter.

```
from enum import Enum

class Foo(Enum):
    FIRST = 'these'
    SECOND = 'usually'
    THIRD = 'don\'t'
    FOURTH = 'matter'
```

However, in certain applications and/or use-cases, you actually do care about the value of each enum member.  Specifically, you may use them as a `verbose_name` or a `pretty_name` for displaying to the user, or you may want to assign it a stateful value and use its contents later.

```
from enum import Enum
from typing import NamedTuple

class FooMember(NamedTuple):
    label: str
    rank: int

class Foo(Enum):
    FIRST = FooMember(label='first', rank=1)
    SECOND = FooMember(label='second', rank=2)
    THIRD = FooMember(label='third', rank=3)
    FOURTH = FooMember(label='fourth', rank=4)

    def __str__(self) -> str:
        return self.value.label
```

As of this writing, `mypy==0.600` is unable to infer the types of the member values. They resolve to `'Any'`:

```
reveal_type(Foo)             # 'def (value: Any) -> foo.Foo'
reveal_type(Foo.FIRST)       # 'foo.Foo'
reveal_type(Foo.FIRST.value) # 'Any'
```

This can be problematic for `mypy` users that rely on type hints to maintain their code base.  When you write a function that returns `Foo.FIRST.value`, our tooling is unable to help us figure out whether this value is a `str`, a `NamedTuple`, or some other value.  Ideally, we would add additional type hints to the Enum:

```
class Foo(Enum):
    value: FooMember
    FIRST = FooMember(label='first', rank=1)
    ...
```

But alas, this requires developer vigilance to remember to do.  If you're maintaining many enums across multiple files, it could be annoying to make sure that they and all future defined Enums are adequately typed.

This pylint plugin will raise errors when `value` is not typed and when the value is typed to something complex and the Enum is missing a `__str__` method.

## Author

[Christopher Sabater Cordero](https://github.com/cs-cordero)




%prep
%autosetup -n pylint_enums-0.0.5

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-pylint-enums -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.5-1
- Package Spec generated