diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-django-admin-display.spec | 589 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 591 insertions, 0 deletions
@@ -0,0 +1 @@ +/django-admin-display-1.3.0.tar.gz diff --git a/python-django-admin-display.spec b/python-django-admin-display.spec new file mode 100644 index 0000000..8400b17 --- /dev/null +++ b/python-django-admin-display.spec @@ -0,0 +1,589 @@ +%global _empty_manifest_terminate_build 0 +Name: python-django-admin-display +Version: 1.3.0 +Release: 1 +Summary: Simplifies the use of function attributes for the django admin and makes mypy happy +License: BSD-3-Clause +URL: https://github.com/escaped/django-admin-display +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/4d/18/e9d271767e4d4da299bb157acbfac6c1b1f8481eaff41d69b44245e14e5e/django-admin-display-1.3.0.tar.gz +BuildArch: noarch + +Requires: python3-django + +%description +# django-admin-display + + + + + + + + +Simplifies the use of function attributes (eg. `short_description`) for the django admin and makes mypy happy :) + +## Requirements + +* Python 3.6.1 or newer +* Django >= 1.11 + +## Usage + +If you want to change the behaviour of how Django displays a read-only value in the admin interface, +you can add some [special attributes](>https://docs.djangoproject.com/en/2.1/ref/contrib/admin/#django.contrib.admin.ModelAdmin.list_display) to the corresponding method. +Supported values are + +`short_description` + Customize the column’s title of the callable. + +`empty_value_display` + Show this value instead, if the value of a field is `None`, an empty string, or an iterable without elements. + +`admin_order_field` + Indicate that the value is represented by a certain database field. + +`boolean` + Display a pretty “on” or “off” icon if the method returns a boolean. + +`allow_tags` (deprecated since Django 1.9) + Disable auto-escaping. + +The following example shows, how you normally apply these attributes to an `AdminModel` or a `Model` method. + +```python +class Company(models.Model): + ... + + def owner(self) -> bool: + return self.owner.last_name + owner.short_description = "Company owner" + owner.admin_order_field = 'owner__last_name' +``` + +This module replaces the way of defining these attributes by providing a handy decorator. + +```python +from django_admin_display import admin_display + + +class Company(models.Model): + ... + + @admin_display( + short_description="Company owner", + admin_order_field='owner__last_name', + ) + def owner(self) -> bool: + return self.owner.last_name +``` + +## Why? + +There are mainly two reasons why this module exists. + +### Usage with `@property` + +It is quite common that a calculated model property is displayed in the admin interface: + +```python +class Company(models.Model): + ... + + @property + def created_on(self) -> datetime.date: + return self.created_at.date() +``` + +In order to add special attributes, you have to create a protected method, +attach the attributes and wrap that method using `property()`: + +```python +class Company(models.Model): + ... + + def _created_on(self) -> datetime.date: + return self.created_at.date() + _created_on.short_description = "Created on" + created_on = property(_created_on) +``` + +This is quite cumbersome, hard to read and most people don't know that this is even possible. +To overcome these downsides you can achieve the same result using the `@admin_display` decorator: + +```python +from django_admin_display import admin_display + + +class Company(models.Model): + ... + + @property + @admin_display( + short_description = "Created on", + ) + def created_on(self) -> datetime.date: + return self.created_at.date() +``` + +### mypy + +If you are using [mypy](http://mypy-lang.org/), you have probably stumbled over an error similar to this one + +> "Callable[[Any, Any], Any]" has no attribute "short_description" + +A common solution is to ignore the type checking by adding `# type: ignore` to the end of the line: + +```python +class CompanyAdmin(admin.ModelAdmin): + ... + + def created_on(self, company: models.Company) -> datetime.date: + return company.created_at.date() + created_on.short_description = "Created on" # type: ignore +``` + +The issue is already known and heavily discussed on [github](https://github.com/python/mypy/issues/2087). + +This decorator solves the issue by internally using `# type: ignore` and providing a well-defined signature for setting the attributes. +It is not an optimal solution but works well until the issue has been resolved. + +## Development + +This project uses [poetry](https://poetry.eustace.io/) for packaging and +managing all dependencies and [pre-commit](https://pre-commit.com/) to run +[flake8](http://flake8.pycqa.org/), [isort](https://pycqa.github.io/isort/), +[mypy](http://mypy-lang.org/) and [black](https://github.com/python/black). + +Clone this repository and run + +```bash +poetry install +poetry run pre-commit install +``` + +to create a virtual enviroment containing all dependencies. +Afterwards, you can run the test suite using + +```bash +poetry run pytest +``` + +This repository follows the [Conventional Commits](https://www.conventionalcommits.org/) +style. + +### Cookiecutter template + +This project was created using [cruft](https://github.com/cruft/cruft) and the +[cookiecutter-pyproject](https://github.com/escaped/cookiecutter-pypackage) template. +In order to update this repository to the latest template version run + +```sh +cruft update +``` + +in the root of this repository. + + + +%package -n python3-django-admin-display +Summary: Simplifies the use of function attributes for the django admin and makes mypy happy +Provides: python-django-admin-display +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-django-admin-display +# django-admin-display + + + + + + + + +Simplifies the use of function attributes (eg. `short_description`) for the django admin and makes mypy happy :) + +## Requirements + +* Python 3.6.1 or newer +* Django >= 1.11 + +## Usage + +If you want to change the behaviour of how Django displays a read-only value in the admin interface, +you can add some [special attributes](>https://docs.djangoproject.com/en/2.1/ref/contrib/admin/#django.contrib.admin.ModelAdmin.list_display) to the corresponding method. +Supported values are + +`short_description` + Customize the column’s title of the callable. + +`empty_value_display` + Show this value instead, if the value of a field is `None`, an empty string, or an iterable without elements. + +`admin_order_field` + Indicate that the value is represented by a certain database field. + +`boolean` + Display a pretty “on” or “off” icon if the method returns a boolean. + +`allow_tags` (deprecated since Django 1.9) + Disable auto-escaping. + +The following example shows, how you normally apply these attributes to an `AdminModel` or a `Model` method. + +```python +class Company(models.Model): + ... + + def owner(self) -> bool: + return self.owner.last_name + owner.short_description = "Company owner" + owner.admin_order_field = 'owner__last_name' +``` + +This module replaces the way of defining these attributes by providing a handy decorator. + +```python +from django_admin_display import admin_display + + +class Company(models.Model): + ... + + @admin_display( + short_description="Company owner", + admin_order_field='owner__last_name', + ) + def owner(self) -> bool: + return self.owner.last_name +``` + +## Why? + +There are mainly two reasons why this module exists. + +### Usage with `@property` + +It is quite common that a calculated model property is displayed in the admin interface: + +```python +class Company(models.Model): + ... + + @property + def created_on(self) -> datetime.date: + return self.created_at.date() +``` + +In order to add special attributes, you have to create a protected method, +attach the attributes and wrap that method using `property()`: + +```python +class Company(models.Model): + ... + + def _created_on(self) -> datetime.date: + return self.created_at.date() + _created_on.short_description = "Created on" + created_on = property(_created_on) +``` + +This is quite cumbersome, hard to read and most people don't know that this is even possible. +To overcome these downsides you can achieve the same result using the `@admin_display` decorator: + +```python +from django_admin_display import admin_display + + +class Company(models.Model): + ... + + @property + @admin_display( + short_description = "Created on", + ) + def created_on(self) -> datetime.date: + return self.created_at.date() +``` + +### mypy + +If you are using [mypy](http://mypy-lang.org/), you have probably stumbled over an error similar to this one + +> "Callable[[Any, Any], Any]" has no attribute "short_description" + +A common solution is to ignore the type checking by adding `# type: ignore` to the end of the line: + +```python +class CompanyAdmin(admin.ModelAdmin): + ... + + def created_on(self, company: models.Company) -> datetime.date: + return company.created_at.date() + created_on.short_description = "Created on" # type: ignore +``` + +The issue is already known and heavily discussed on [github](https://github.com/python/mypy/issues/2087). + +This decorator solves the issue by internally using `# type: ignore` and providing a well-defined signature for setting the attributes. +It is not an optimal solution but works well until the issue has been resolved. + +## Development + +This project uses [poetry](https://poetry.eustace.io/) for packaging and +managing all dependencies and [pre-commit](https://pre-commit.com/) to run +[flake8](http://flake8.pycqa.org/), [isort](https://pycqa.github.io/isort/), +[mypy](http://mypy-lang.org/) and [black](https://github.com/python/black). + +Clone this repository and run + +```bash +poetry install +poetry run pre-commit install +``` + +to create a virtual enviroment containing all dependencies. +Afterwards, you can run the test suite using + +```bash +poetry run pytest +``` + +This repository follows the [Conventional Commits](https://www.conventionalcommits.org/) +style. + +### Cookiecutter template + +This project was created using [cruft](https://github.com/cruft/cruft) and the +[cookiecutter-pyproject](https://github.com/escaped/cookiecutter-pypackage) template. +In order to update this repository to the latest template version run + +```sh +cruft update +``` + +in the root of this repository. + + + +%package help +Summary: Development documents and examples for django-admin-display +Provides: python3-django-admin-display-doc +%description help +# django-admin-display + + + + + + + + +Simplifies the use of function attributes (eg. `short_description`) for the django admin and makes mypy happy :) + +## Requirements + +* Python 3.6.1 or newer +* Django >= 1.11 + +## Usage + +If you want to change the behaviour of how Django displays a read-only value in the admin interface, +you can add some [special attributes](>https://docs.djangoproject.com/en/2.1/ref/contrib/admin/#django.contrib.admin.ModelAdmin.list_display) to the corresponding method. +Supported values are + +`short_description` + Customize the column’s title of the callable. + +`empty_value_display` + Show this value instead, if the value of a field is `None`, an empty string, or an iterable without elements. + +`admin_order_field` + Indicate that the value is represented by a certain database field. + +`boolean` + Display a pretty “on” or “off” icon if the method returns a boolean. + +`allow_tags` (deprecated since Django 1.9) + Disable auto-escaping. + +The following example shows, how you normally apply these attributes to an `AdminModel` or a `Model` method. + +```python +class Company(models.Model): + ... + + def owner(self) -> bool: + return self.owner.last_name + owner.short_description = "Company owner" + owner.admin_order_field = 'owner__last_name' +``` + +This module replaces the way of defining these attributes by providing a handy decorator. + +```python +from django_admin_display import admin_display + + +class Company(models.Model): + ... + + @admin_display( + short_description="Company owner", + admin_order_field='owner__last_name', + ) + def owner(self) -> bool: + return self.owner.last_name +``` + +## Why? + +There are mainly two reasons why this module exists. + +### Usage with `@property` + +It is quite common that a calculated model property is displayed in the admin interface: + +```python +class Company(models.Model): + ... + + @property + def created_on(self) -> datetime.date: + return self.created_at.date() +``` + +In order to add special attributes, you have to create a protected method, +attach the attributes and wrap that method using `property()`: + +```python +class Company(models.Model): + ... + + def _created_on(self) -> datetime.date: + return self.created_at.date() + _created_on.short_description = "Created on" + created_on = property(_created_on) +``` + +This is quite cumbersome, hard to read and most people don't know that this is even possible. +To overcome these downsides you can achieve the same result using the `@admin_display` decorator: + +```python +from django_admin_display import admin_display + + +class Company(models.Model): + ... + + @property + @admin_display( + short_description = "Created on", + ) + def created_on(self) -> datetime.date: + return self.created_at.date() +``` + +### mypy + +If you are using [mypy](http://mypy-lang.org/), you have probably stumbled over an error similar to this one + +> "Callable[[Any, Any], Any]" has no attribute "short_description" + +A common solution is to ignore the type checking by adding `# type: ignore` to the end of the line: + +```python +class CompanyAdmin(admin.ModelAdmin): + ... + + def created_on(self, company: models.Company) -> datetime.date: + return company.created_at.date() + created_on.short_description = "Created on" # type: ignore +``` + +The issue is already known and heavily discussed on [github](https://github.com/python/mypy/issues/2087). + +This decorator solves the issue by internally using `# type: ignore` and providing a well-defined signature for setting the attributes. +It is not an optimal solution but works well until the issue has been resolved. + +## Development + +This project uses [poetry](https://poetry.eustace.io/) for packaging and +managing all dependencies and [pre-commit](https://pre-commit.com/) to run +[flake8](http://flake8.pycqa.org/), [isort](https://pycqa.github.io/isort/), +[mypy](http://mypy-lang.org/) and [black](https://github.com/python/black). + +Clone this repository and run + +```bash +poetry install +poetry run pre-commit install +``` + +to create a virtual enviroment containing all dependencies. +Afterwards, you can run the test suite using + +```bash +poetry run pytest +``` + +This repository follows the [Conventional Commits](https://www.conventionalcommits.org/) +style. + +### Cookiecutter template + +This project was created using [cruft](https://github.com/cruft/cruft) and the +[cookiecutter-pyproject](https://github.com/escaped/cookiecutter-pypackage) template. +In order to update this repository to the latest template version run + +```sh +cruft update +``` + +in the root of this repository. + + + +%prep +%autosetup -n django-admin-display-1.3.0 + +%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-django-admin-display -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 1.3.0-1 +- Package Spec generated @@ -0,0 +1 @@ +7f8567f1b317e4647056a143be9df275 django-admin-display-1.3.0.tar.gz |