Re: Structuring an API in a large project

On Thu, May 1, 2014 at 8:15 PM, Mike Dewhirst <miked@dewhirst.com.au> wrote:

On 2/05/2014 10:29 AM, Adam "Cezar" Jenkins wrote:

On Thu, May 1, 2014 at 5:36 PM, Mike Dewhirst <miked@dewhirst.com.au

<mailto:miked@dewhirst.com.au>> wrote:

    On 2/05/2014 2:16 AM, Adam "Cezar" Jenkins wrote:

        On Thu, May 1, 2014 at 11:10 AM, Venkatraman S
        <venkat83@gmail.com <mailto:venkat83@gmail.com>

        <mailto:venkat83@gmail.com <mailto:venkat83@gmail.com>>> wrote:



        Â  Â  On Thu, May 1, 2014 at 9:29 PM, Cezar Jenkins
        Â  Â  <emperorcezar@gmail.com <mailto:emperorcezar@gmail.com>
        <mailto:emperorcezar@gmail.com
        <mailto:emperorcezar@gmail.com>__>> wrote:

        Â  Â  Â  Â  Right now I have a large project with an equally
        large API (done
        Â  Â  Â  Â  using django rest framework). The current structure
        is something
        Â  Â  Â  Â  like this:

        Â  Â  Â  Â  api
        Â  Â  Â  Â  |-----urls.py
        Â  Â  Â  Â  |-----models.py
        Â  Â  Â  Â  |
        Â  Â  Â  Â  ----v1
          Â  Â  Â  Ã‚  Â  |-----views.py
          Â  Â  Â  Ã‚  Â  |-----serializers.py
          Â  Â  Â  Ã‚  Â  |-----permissions.py
          Â  Â  Â  Ã‚  Â  |-----tests.py


        Â  Â  Â  Â  etc

        Â  Â  Â  Â  As you can guess, the views.py file is pretty big
        and I want to
        Â  Â  Â  Â  refactor this out. Currently I have a few options in
        front of
        Â  Â  Â  Â  me, the one I'm leaning towards is to put an
        'api/v1' package
        Â  Â  Â  Â  into each app and use the api app to tie all the
        urls together
        Â  Â  Â  Â  and hold views that don't fall into an app.


        Â  Â  If the only pain point is the big views file, then why not
        just
          Â  refactor that into multiple files under 'v1' Â itself -
        nothing is
          Â  stopping you from doing that.Â

        That was one way I started refactoring, but ran into issues. Say
        I have
        a destinations.py view file in the api, but I also have a
        destinations
        app. In my views file I can't do 'from destinations.models import
        Destination' cause the name conflicts. So I started having to name
        things 'destinations_api.py' which seemed really dirty.


    I might have missed something here but the usual Django way of
    refactoring a large views (models too) file is to convert it into a
    directory containing a file for each view. Then you can still refer
    to each view using the dotted names as previously. No need to change
    other code in other parts of the app which calls them.


You're correct that code outside of those view wouldn't have to change,
but the name of the file the view is in can clash with something outside
that file.

But if inside the app.views.__init__.py file you import the view classes and defs you can call them without mentioning the filenames within which they exist eg.

from __future__ import absolute_import (if you are using Python 2.x)
from .conflictingfilename import ClassyView, defined_function

Thereafter, elsewhere you can call ...

app.views.ClassyView.function_within_classyview()
app.views.defined_function()

Thanks. This is actually a really great work around.

 

Â


        Â

        Â  Â  --
        Â  Â  You received this message because you are subscribed to a
        topic in
        Â  Â  the Google Groups "Django users" group.
        Â  Â  To unsubscribe from this topic, visit
        Â  Â
        https://groups.google.com/d/__topic/django-users/__rizwdsi5o1k/unsubscribe
        <https://groups.google.com/d/topic/django-users/rizwdsi5o1k/unsubscribe>.
        Â  Â  To unsubscribe from this group and all its topics, send an
        email to
        Â  Â django-users+unsubscribe@__googlegroups.com
        <mailto:django-users%2Bunsubscribe@googlegroups.com>
        Â  Â  <mailto:django-users+__unsubscribe@googlegroups.com
        <mailto:django-users%2Bunsubscribe@googlegroups.com>>.

        Â  Â  To post to this group, send email to
        django-users@googlegroups.com <mailto:django-users@googlegroups.com>
        Â  Â  <mailto:django-users@__googlegroups.com
        <mailto:django-users@googlegroups.com>>.

        Â  Â  Visit this group at
        http://groups.google.com/__group/django-users
        <http://groups.google.com/group/django-users>.
        Â  Â  To view this discussion on the web visit
        Â  Â
        https://groups.google.com/d/__msgid/django-users/__CAN7tdFT0BAG5XoKoiavKr7v24DqSQ__Tc7D%2Bq5EY7Wgoh_VzvzeA%__40mail.gmail.com
        <https://groups.google.com/d/msgid/django-users/CAN7tdFT0BAG5XoKoiavKr7v24DqSQTc7D%2Bq5EY7Wgoh_VzvzeA%40mail.gmail.com>
        Â  Â
        <https://groups.google.com/d/__msgid/django-users/__CAN7tdFT0BAG5XoKoiavKr7v24DqSQ__Tc7D%2Bq5EY7Wgoh_VzvzeA%__40mail.gmail.com?utm_medium=__email&utm_source=footer
        <https://groups.google.com/d/msgid/django-users/CAN7tdFT0BAG5XoKoiavKr7v24DqSQTc7D%2Bq5EY7Wgoh_VzvzeA%40mail.gmail.com?utm_medium=email&utm_source=footer>>.


        Â  Â  For more options, visit
        https://groups.google.com/d/__optout
        <https://groups.google.com/d/optout>.

        --
        You received this message because you are subscribed to the Google
        Groups "Django users" group.
        To unsubscribe from this group and stop receiving emails from
        it, send

        an email to django-users+unsubscribe@__googlegroups.com
        <mailto:django-users%2Bunsubscribe@googlegroups.com>
        <mailto:django-users+__unsubscribe@googlegroups.com
        <mailto:django-users%2Bunsubscribe@googlegroups.com>>.

        To post to this group, send email to
        django-users@googlegroups.com <mailto:django-users@googlegroups.com>

        <mailto:django-users@__googlegroups.com

        <mailto:django-users@googlegroups.com>>.

        Visit this group at

        http://groups.google.com/__group/django-users
        <http://groups.google.com/group/django-users>.

        To view this discussion on the web visit

        https://groups.google.com/d/__msgid/django-users/__CAN6vQqtUML2-o3pkx02o%__2BnsZ0nnYCUC6XULjw--__MdRwRyOcsdg%40mail.gmail.com
        <https://groups.google.com/d/msgid/django-users/CAN6vQqtUML2-o3pkx02o%2BnsZ0nnYCUC6XULjw--MdRwRyOcsdg%40mail.gmail.com>
        <https://groups.google.com/d/__msgid/django-users/__CAN6vQqtUML2-o3pkx02o%__2BnsZ0nnYCUC6XULjw--__MdRwRyOcsdg%40mail.gmail.com?__utm_medium=email&utm_source=__footer
        <https://groups.google.com/d/msgid/django-users/CAN6vQqtUML2-o3pkx02o%2BnsZ0nnYCUC6XULjw--MdRwRyOcsdg%40mail.gmail.com?utm_medium=email&utm_source=footer>>.

        For more options, visit https://groups.google.com/d/__optout
        <https://groups.google.com/d/optout>.

    --
    You received this message because you are subscribed to a topic in
    the Google Groups "Django users" group.
    To unsubscribe from this topic, visit

    https://groups.google.com/d/__topic/django-users/__rizwdsi5o1k/unsubscribe
    <https://groups.google.com/d/topic/django-users/rizwdsi5o1k/unsubscribe>.

    To unsubscribe from this group and all its topics, send an email to

    django-users+unsubscribe@__googlegroups.com
    <mailto:django-users%2Bunsubscribe@googlegroups.com>.

    To post to this group, send email to django-users@googlegroups.com
    <mailto:django-users@googlegroups.com>.

    Visit this group at http://groups.google.com/__group/django-users
    <http://groups.google.com/group/django-users>.

    To view this discussion on the web visit

    https://groups.google.com/d/__msgid/django-users/5362CC50.__5060905%40dewhirst.com.au
    <https://groups.google.com/d/msgid/django-users/5362CC50.5060905%40dewhirst.com.au>.

    For more options, visit https://groups.google.com/d/__optout
    <https://groups.google.com/d/optout>.

--
You received this message because you are subscribed to the Google
Groups "Django users" group.
To unsubscribe from this group and stop receiving emails from it, send
an email to django-users+unsubscribe@googlegroups.com
<mailto:django-users+unsubscribe@googlegroups.com>.
To post to this group, send email to django-users@googlegroups.com
<mailto:django-users@googlegroups.com>.
Visit this group at http://groups.google.com/group/django-users.
To view this discussion on the web visit

https://groups.google.com/d/msgid/django-users/CAN6vQquB1Lsmq%2BeH1D9imZFOVr7H8Gr0%3D5VqaxCE6K_iAB1SYQ%40mail.gmail.com
<https://groups.google.com/d/msgid/django-users/CAN6vQquB1Lsmq%2BeH1D9imZFOVr7H8Gr0%3D5VqaxCE6K_iAB1SYQ%40mail.gmail.com?utm_medium=email&utm_source=footer>.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to a topic in the Google Groups "Django users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/django-users/rizwdsi5o1k/unsubscribe.
To unsubscribe from this group and all its topics, send an email to django-users+unsubscribe@googlegroups.com.
To post to this group, send email to django-users@googlegroups.com.
Visit this group at http://groups.google.com/group/django-users.

To view this discussion on the web visit https://groups.google.com/d/msgid/django-users/5362F1C7.7010500%40dewhirst.com.au.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Django users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to django-users+unsubscribe@googlegroups.com.
To post to this group, send email to django-users@googlegroups.com.
Visit this group at http://groups.google.com/group/django-users.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-users/CAN6vQqurb7HFZiT-Wa3YG2z7j_F7H9kw9sH9mwrk-hXGStzRgQ%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.