Skip to content

restructure project directories #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 24, 2025
Merged

restructure project directories #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
05958e3
restructure the package without `a` prefix
amirreza8002 Mar 24, 2025
a43c36f
adjust documentations with the new file structure
amirreza8002 Mar 24, 2025
04361a6
adjust tests with the new file structure
amirreza8002 Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions django_async_extensions/aforms/__init__.py
View file
Open in desktop

This file was deleted.

0 django_async_extensions/acontrib/__init__.py → django_async_extensions/contrib/__init__.py
View file
Open in desktop
File renamed without changes.
0 ...sync_extensions/acontrib/auth/__init__.py → ...async_extensions/contrib/auth/__init__.py
View file
Open in desktop
File renamed without changes.
0 ..._async_extensions/acontrib/auth/mixins.py → ...o_async_extensions/contrib/auth/mixins.py
View file
Open in desktop
File renamed without changes.
0 django_async_extensions/acore/__init__.py → django_async_extensions/core/__init__.py
View file
Open in desktop
File renamed without changes.
0 django_async_extensions/acore/paginator.py → django_async_extensions/core/paginator.py
View file
Open in desktop
File renamed without changes.
4 changes: 4 additions & 0 deletions django_async_extensions/forms/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from django_async_extensions.forms.models import AsyncModelForm


__all__ = ("AsyncModelForm",)
2 changes: 1 addition & 1 deletion django_async_extensions/aforms/models.py → django_async_extensions/forms/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from django.forms.models import ModelForm

from django_async_extensions.aforms.utils import AsyncRenderableFormMixin
from django_async_extensions.forms.utils import AsyncRenderableFormMixin


class AsyncModelForm(AsyncRenderableFormMixin, ModelForm):
Expand Down
0 django_async_extensions/aforms/utils.py → django_async_extensions/forms/utils.py
View file
Open in desktop
File renamed without changes.
0 ..._async_extensions/amiddleware/__init__.py → ...o_async_extensions/middleware/__init__.py
View file
Open in desktop
File renamed without changes.
0 django_async_extensions/amiddleware/base.py → django_async_extensions/middleware/base.py
View file
Open in desktop
File renamed without changes.
0 django_async_extensions/aviews/__init__.py → django_async_extensions/views/__init__.py
View file
Open in desktop
File renamed without changes.
10 changes: 5 additions & 5 deletions ...ync_extensions/aviews/generic/__init__.py → ...sync_extensions/views/generic/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
from django_async_extensions.aviews.generic.base import (
from django_async_extensions.views.generic.base import (
AsyncView,
AsyncTemplateView,
AsyncRedirectView,
)
from django_async_extensions.aviews.generic.dates import (
from django_async_extensions.views.generic.dates import (
AsyncArchiveIndexView,
AsyncDateDetailView,
AsyncDayArchiveView,
Expand All @@ -12,14 +12,14 @@
AsyncWeekArchiveView,
AsyncYearArchiveView,
)
from django_async_extensions.aviews.generic.detail import AsyncDetailView
from django_async_extensions.aviews.generic.edit import (
from django_async_extensions.views.generic.detail import AsyncDetailView
from django_async_extensions.views.generic.edit import (
AsyncCreateView,
AsyncDeleteView,
AsyncFormView,
AsyncUpdateView,
)
from django_async_extensions.aviews.generic.list import AsyncListView
from django_async_extensions.views.generic.list import AsyncListView


__all__ = [
Expand Down
0 ...o_async_extensions/aviews/generic/base.py → ...go_async_extensions/views/generic/base.py
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions ..._async_extensions/aviews/generic/dates.py → ...o_async_extensions/views/generic/dates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@
DateMixin,
)

from django_async_extensions.aviews.generic.base import AsyncView
from django_async_extensions.aviews.generic.detail import (
from django_async_extensions.views.generic.base import AsyncView
from django_async_extensions.views.generic.detail import (
AsyncBaseDetailView,
AsyncSingleObjectTemplateResponseMixin,
)
from django_async_extensions.aviews.generic.list import (
from django_async_extensions.views.generic.list import (
AsyncMultipleObjectMixin,
AsyncMultipleObjectTemplateResponseMixin,
)
Expand Down
2 changes: 1 addition & 1 deletion ...async_extensions/aviews/generic/detail.py → ..._async_extensions/views/generic/detail.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from django.http import Http404
from django.utils.translation import gettext as _

from django_async_extensions.aviews.generic.base import (
from django_async_extensions.views.generic.base import (
AsyncView,
AsyncContextMixin,
AsyncTemplateResponseMixin,
Expand Down
6 changes: 3 additions & 3 deletions ...o_async_extensions/aviews/generic/edit.py → ...go_async_extensions/views/generic/edit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
from django.forms import models as model_forms
from django.http import HttpResponseRedirect

from django_async_extensions.aforms.models import AsyncModelForm
from django_async_extensions.aviews.generic.base import (
from django_async_extensions.forms.models import AsyncModelForm
from django_async_extensions.views.generic.base import (
AsyncView,
AsyncContextMixin,
AsyncTemplateResponseMixin,
)
from django_async_extensions.aviews.generic.detail import (
from django_async_extensions.views.generic.detail import (
AsyncSingleObjectMixin,
AsyncBaseDetailView,
AsyncSingleObjectTemplateResponseMixin,
Expand Down
4 changes: 2 additions & 2 deletions ...o_async_extensions/aviews/generic/list.py → ...go_async_extensions/views/generic/list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
from django.http import Http404
from django.utils.translation import gettext as _

from django_async_extensions.acore.paginator import AsyncPaginator
from django_async_extensions.aviews.generic.base import (
from django_async_extensions.core.paginator import AsyncPaginator
from django_async_extensions.views.generic.base import (
AsyncView,
AsyncContextMixin,
AsyncTemplateResponseMixin,
Expand Down
4 changes: 2 additions & 2 deletions docs/contrib/async-auth/mixins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
django has a set of mixins that help with limiting access and enforcing authentication and permissions,
but these mixins do not work with async views.

to help with that an async version of the mixins are included in the `acontrib.auth.mixins` module.
to help with that an async version of the mixins are included in the `contrib.auth.mixins` module.

**note**: these mixins only work with `AsyncView` or classes that inherit from it, or implement the same logic.

Expand All @@ -16,7 +16,7 @@ works similar to [LoginRequiredMixin](https://docs.djangoproject.com/en/5.1/topi
also the `dispatch()` method is async.

```python
from django_async_extensions.acontrib.auth.mixins import AsyncLoginRequiredMixin
from django_async_extensions.contrib.auth.mixins import AsyncLoginRequiredMixin


class MyView(AsyncLoginRequiredMixin, AsyncView):
Expand Down
4 changes: 2 additions & 2 deletions docs/core/async-paginator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ and using querysets in an async environment is different from using querysets in
#### Example of list pagination

```pycon
In [1]: from django_async_extensions.acore.paginator import AsyncPaginator
In [1]: from django_async_extensions.core.paginator import AsyncPaginator

In [2]: objects = ["john", "paul", "george", "ringo"]

Expand Down Expand Up @@ -92,7 +92,7 @@ In [2]: objs = [User(username=f"test{i}", password="testpass123") for i in range
In [3]: User.objects.bulk_create(objs)
Out[3]: [<User: test1>, <User: test2>, <User: test3>, <User: test4>]

In [4]: from django_async_extensions.acore.paginator import AsyncPaginator
In [4]: from django_async_extensions.core.paginator import AsyncPaginator

In [5]: users = User.objects.order_by("username")

Expand Down
2 changes: 1 addition & 1 deletion docs/forms/model_form.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class Author(models.Model):

*Example myapp/forms.py*:
```python
from django_async_extensions.aforms import AsyncModelForm
from django_async_extensions.forms import AsyncModelForm
from myapp.models import Author


Expand Down
14 changes: 7 additions & 7 deletions docs/views/async-class-based-views/base.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
async CBVs are supported via the `AsyncView` class.

```python
from django_async_extensions.aviews.generic import AsyncView
from django_async_extensions.views.generic import AsyncView


class MyView(AsyncView):
Expand All @@ -22,7 +22,7 @@ the `AsyncView` works similar to django's [View](https://docs.djangoproject.com/
for easy use an async version of `TemplateView` is available

```python
from django_async_extensions.aviews.generic import AsyncTemplateView
from django_async_extensions.views.generic import AsyncTemplateView

class MyTemplateView(AsyncTemplateView):
template_name = "template.html"
Expand All @@ -32,10 +32,10 @@ class MyTemplateView(AsyncTemplateView):

*Ancestors (MRO)*:

1. [django_async_extensions.aviews.generic.base.AsyncTemplateResponseMixin](mixins-simple.md#asynctemplateresponsemixin)
1. [django_async_extensions.views.generic.base.AsyncTemplateResponseMixin](mixins-simple.md#asynctemplateresponsemixin)
2. [django.views.generic.base.TemplateResponseMixin](https://docs.djangoproject.com/en/5.1/ref/class-based-views/mixins-simple/#django.views.generic.base.TemplateResponseMixin)
3. [django_async_extensions.aviews.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
4. [django_async_extensions.aviews.generic.base.AsyncView](base.md#asyncview)
3. [django_async_extensions.views.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
4. [django_async_extensions.views.generic.base.AsyncView](base.md#asyncview)
5. [django.views.generic.base.View](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#django.views.generic.base.View)


Expand All @@ -44,7 +44,7 @@ class MyTemplateView(AsyncTemplateView):
an async version of `RedirectView` is also available

```python
from django_async_extensions.aviews.generic import AsyncRedirectView
from django_async_extensions.views.generic import AsyncRedirectView

class ThisRedirectView(AsyncRedirectView):
pattern_name = "that-view"
Expand All @@ -54,6 +54,6 @@ class ThisRedirectView(AsyncRedirectView):

*Ancestors (MRO)*:

1. [django_async_extensions.aviews.generic.base.AsyncView](base.md#asyncview)
1. [django_async_extensions.views.generic.base.AsyncView](base.md#asyncview)
2. [django.views.generic.base.RedirectView](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#redirectview)
3. [django.views.generic.base.View](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#django.views.generic.base.View)
20 changes: 10 additions & 10 deletions docs/views/async-class-based-views/detail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
`AsyncDetailView` generic view is provided

```python
from django_async_extensions.aviews.generic import AsyncDetailView
from django_async_extensions.views.generic import AsyncDetailView

class MyDetailView(AsyncDetailView):
model = MyModel
Expand All @@ -18,13 +18,13 @@ class MyDetailView(AsyncDetailView):

*Ancestors (MRO)*:

1. [django-async-extensions.aviews.generic.detail.AsyncSingleObjectTemplateResponseMixin](mixins-single-object.md#asyncsingleobjecttemplateresponsemixin)
2. [django-async-extensions.aviews.generic.base.AsyncTemplateResponseMixin](mixins-simple.md#asynctemplateresponsemixin)
1. [django-async-extensions.views.generic.detail.AsyncSingleObjectTemplateResponseMixin](mixins-single-object.md#asyncsingleobjecttemplateresponsemixin)
2. [django-async-extensions.views.generic.base.AsyncTemplateResponseMixin](mixins-simple.md#asynctemplateresponsemixin)
3. [django.views.generic.base.TemplateResponseMixin](https://docs.djangoproject.com/en/5.1/ref/class-based-views/mixins-simple/#django.views.generic.base.TemplateResponseMixin)
4. [django_async_extensions.aviews.generic.detail.AsyncBaseDetailView](detail.md#asyncbasedetailview)
5. [django_async_extensions.aviews.generic.detail.AsyncSingleObjectMixin](mixins-single-object.md#asyncsingleobjectmixin)
6. [django_async_extensions.aviews.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
7. [django_async_extensions.aviews.generic.base.AsyncView](base.md#asyncview)
4. [django_async_extensions.views.generic.detail.AsyncBaseDetailView](detail.md#asyncbasedetailview)
5. [django_async_extensions.views.generic.detail.AsyncSingleObjectMixin](mixins-single-object.md#asyncsingleobjectmixin)
6. [django_async_extensions.views.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
7. [django_async_extensions.views.generic.base.AsyncView](base.md#asyncview)
8. [django.views.generic.base.View](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#django.views.generic.base.View)


Expand All @@ -37,7 +37,7 @@ like [BaseDetailView](https://docs.djangoproject.com/en/5.1/ref/class-based-view

*Ancestors (MRO)*:

1. [django_async_extensions.aviews.generic.detail.AsyncSingleObjectMixin](mixins-single-object.md#asyncsingleobjectmixin)
2. [django_async_extensions.aviews.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
3. [django_async_extensions.aviews.generic.base.AsyncView](base.md#asyncview)
1. [django_async_extensions.views.generic.detail.AsyncSingleObjectMixin](mixins-single-object.md#asyncsingleobjectmixin)
2. [django_async_extensions.views.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
3. [django_async_extensions.views.generic.base.AsyncView](base.md#asyncview)
4. [django.views.generic.base.View](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#django.views.generic.base.View)
Loading
Loading