pyscaffold / pyscaffoldext-django / 24

pending completion

Build # 24

Build Type

Pull #2

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/pyscaffold/pyscaffoldext-django/commit/<a class=hub.com/pyscaffold/pyscaffoldext-django/commit/<a class="double-link" href="https://git"><a class=hub.com/pyscaffold/pyscaffoldext-django/commit/<a class="double-link" href="https://git"><a class=hub.com/pyscaffold/pyscaffoldext-django/commit/<a class="double-link" href="https://git"><a class=hub.com/pyscaffold/pyscaffoldext-django/commit/545fc92cd47454c9fa10b7c22fe434a8d0972466">545fc92cd">&lt;a href=&quot;https://github.com/pyscaffold/pyscaffoldext-django/commit/</a><a class="double-link" href="https://github.com/pyscaffold/pyscaffoldext-django/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/pyscaffold/pyscaffoldext-django/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/pyscaffold/pyscaffoldext-django/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/pyscaffold/pyscaffoldext-django/commit/545fc92cd47454c9fa10b7c22fe434a8d0972466">545fc92cd</a><a href="https://github.com/pyscaffold/pyscaffoldext-django/commit/545fc92cd47454c9fa10b7c22fe434a8d0972466">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/pyscaffold/pyscaffoldext-django/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/pyscaffold/pyscaffoldext-django/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/pyscaffold/pyscaffoldext-django/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/pyscaffold/pyscaffoldext-django/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/pyscaffold/pyscaffoldext-django/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/pyscaffold/pyscaffoldext-django/commit/545fc92cd47454c9fa10b7c22fe434a8d0972466&quot;&gt;545fc92cd&lt;/a&gt;&lt;a href=&quot;https://github.com/pyscaffold/pyscaffoldext-django/commit/545fc92cd47454c9fa10b7c22fe434a8d0972466&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/pyscaffold/pyscaffoldext-django/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp... (continued)

Pull Request Pull Request #2: Fix Django manage.py

Run Details

16 of 19 branches covered (84.21%)

Branch coverage included in aggregate %.

74 of 74 new or added lines in 2 files covered. (100.0%)

100 of 110 relevant lines covered (90.91%)

0.91 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

89.91

/src/pyscaffoldext/django/extension.py

# -*- coding: utf-8 -*-
"""
Extension that creates a base structure for the project using django-admin.py.

Warning:
    *Deprecation Notice* - In the next major release the Django extension
    will be extracted into an independent package.
    After PyScaffold v4.0, you will need to explicitly install
    ``pyscaffoldext-django`` in your system/virtualenv in order to be
    able to use it.
"""
import re
import stat
from pathlib import Path

from pyscaffold.api import Extension, helpers
from pyscaffold.log import logger
from pyscaffold.shell import ShellCommand
from pyscaffold.warnings import UpdateNotSupported

from . import templates

django_admin = ShellCommand("django-admin.py")


class Django(Extension):
    """Generate Django project files"""

    mutually_exclusive = True

    try:
        # TODO: Remove this try/except block on PyScaffold >= 4.x
        from pyscaffold.extensions import django  # Check if django is a builtin

        del django

        # WORKAROUND:
        #
        # This avoids raising an error by using `add_argument` with an
        # option/flag that was already used and at the same time provides
        # a unequivocal way of accessing the newest implementation in the
        # tests via the `--x-` prefix.
        #
        # For the time being this is useful to run against an existing
        # version of PyScaffold that have an old implementation of this
        # extension built into the core of the system. Once the builtin
        # extension is removed in future versions, the following overwriting
        # of the augment_cli method is not required.

        def augment_cli(self, parser):
            parser.add_argument(
                self.xflag,
                help="Newest version of `{}`, in development".format(self.flag),
                dest="extensions",
                action="append_const",
                const=self,
            )

        # TODO: Remove on PyScaffold 4.x
        @property
        def xflag(self):
            return "--x-" + self.flag.strip("-")

    except ImportError:
        pass  # Never mind, we are in a recent version of PyScaffold

    def activate(self, actions):
        """Register hooks to generate project using django-admin.

        Args:
            actions (list): list of actions to perform

        Returns:
            list: updated list of actions
        """

        # `get_default_options` uses passed options to compute derived ones,
        # so it is better to prepend actions that modify options.
        actions = helpers.register(
            actions, enforce_django_options, before="get_default_options"
        )
        # `apply_update_rules` uses CWD information,
        # so it is better to prepend actions that modify it.
        actions = helpers.register(
            actions, create_django_proj, before="apply_update_rules"
        )

        return actions + [instruct_user]


def enforce_django_options(struct, opts):
    """Make sure options reflect the Django usage.

    Args:
        struct (dict): project representation as (possibly) nested
            :obj:`dict`.
        opts (dict): given options, see :obj:`create_project` for
            an extensive list.

    Returns:
        struct, opts: updated project representation and options
    """
    opts["package"] = opts["project"]  # required by Django
    opts["force"] = True
    opts.setdefault("requirements", []).append("django")

    return struct, opts


def create_django_proj(struct, opts):
    """Creates a standard Django project with django-admin.py

    Args:
        struct (dict): project representation as (possibly) nested
            :obj:`dict`.
        opts (dict): given options, see :obj:`create_project` for
            an extensive list.

    Returns:
        struct, opts: updated project representation and options

    Raises:
        :obj:`RuntimeError`: raised if django-admin.py is not installed
    """
    if opts.get("update"):
        helpers.logger.warning(UpdateNotSupported(extension="django"))
        return struct, opts

    try:
        django_admin("--version")
    except Exception as e:
        raise DjangoAdminNotInstalled from e

    # TODO: replace project with project_path / name in PyScaffold 4.x

    pretend = opts.get("pretend")
    project_path = Path(opts["project"])
    pkg_name = opts["project"]

    django_admin("startproject", str(project_path), log=True, pretend=pretend)

    src_dir = project_path / "src"
    pkg_dir = src_dir / pkg_name
    orig_dir = project_path / pkg_name

    if not pretend:
        src_dir.mkdir(exist_ok=True)
        orig_dir.rename(pkg_dir)
    helpers.logger.report("move", orig_dir, target=pkg_dir)

    manage = project_path / "manage.py"
    main = pkg_dir / "__main__.py"

    if not pretend:
        manage.rename(main)
    helpers.logger.report("move", manage, target=main)

    settings = pkg_dir / "settings.py"
    replace_default_database(helpers.logger, settings, pretend=pretend)

    if not pretend:
        manage.write_text(templates.manage(opts))
        manage.chmod(manage.stat().st_mode | stat.S_IXUSR)
    helpers.logger.report("create", manage)
    helpers.logger.report("chmod", "+x {}".format(manage))

    struct = helpers.modify(
        struct,
        project_path / ".gitignore",
        lambda contents: "{}\n\n# Django\n/*.sqlite3".format(contents),
    )

    return struct, opts


def instruct_user(struct, opts):
    logger.warning(
        "\nDjango is used to create web applications while PyScaffold makes it "
        "easy to create re-usable Python (pip) packages, such as libraries.\n"
        "There is nothing wrong with trying to distribute your web application "
        "as an installable package, but you have to be aware about the changes "
        "in mindset. Please check the official docs in\n\n"
        "\thttps://pyscaffold.org/projects/django\n\n"
        "for more information.\n"
    )

    return struct, opts


PATTERN = re.compile(r"os\.path\.join\(BASE_DIR, ['\"]db\.sqlite3['\"]\)")
REPLACEMENT = 'os.path.join(os.path.dirname(BASE_DIR), "db.sqlite3")'


def replace_default_database(
    logger, file_path, pattern=PATTERN, replacement=REPLACEMENT, pretend=False
):
    exception = DjangoVersionMightBeUnsupported(
        "Failed attempt to replace the default sqlite3 database file with "
        "{} in {}.".format(REPLACEMENT, file_path)
    )

    try:
        if not pretend:
            text = file_path.read_text()
            replaced, n = pattern.subn(replacement, text)
            if n < 1:
                # No substitution was made, there is something wrong with the
                # assumptions on how the file should be.
                raise SystemError(text)
                raise exception
            file_path.write_text(replaced)
        logger.report("replace", "default database in {}".format(file_path))
    except PyScaffoldDjangoError:
        raise
    except Exception as ex:
        raise exception from ex


class PyScaffoldDjangoError(RuntimeError):
    """Base class for all the exceptions in this package"""


class DjangoVersionMightBeUnsupported(PyScaffoldDjangoError):
    """The files generated by django-admin.py are different from expected."""

    EXTRA = (
        "\nA possible reason for that is that a new version of Django is "
        "incompatible with pyscaffoldext-django.\n"
        "Please visit the documentation in https://pyscaffold.org/projects/django "
        "and follow the steps to integrate django manually.\n"
        "Please also consider submitting a pull request with the fix."
    )

    def __init__(self, message=None, *args, **kwargs):
        message = (message or self.__class__.__doc__) + self.EXTRA
        super(DjangoVersionMightBeUnsupported, self).__init__(message, *args, **kwargs)


class DjangoAdminNotInstalled(PyScaffoldDjangoError):
    """This extension depends on the ``django-admin.py`` cli script."""

    DEFAULT_MESSAGE = "django-admin.py is not installed, " "run: pip install django"

    def __init__(self, message=DEFAULT_MESSAGE, *args, **kwargs):
        super(DjangoAdminNotInstalled, self).__init__(message, *args, **kwargs)

1	# -- coding: utf-8 --
2	"""	1✔
3	Extension that creates a base structure for the project using django-admin.py.
4
5	Warning:
6	Deprecation Notice - In the next major release the Django extension
7	will be extracted into an independent package.
8	After PyScaffold v4.0, you will need to explicitly install
9	``pyscaffoldext-django`` in your system/virtualenv in order to be
10	able to use it.
11	"""
12	import re	1✔
13	import stat	1✔
14	from pathlib import Path	1✔
15
16	from pyscaffold.api import Extension, helpers	1✔
17	from pyscaffold.log import logger	1✔
18	from pyscaffold.shell import ShellCommand	1✔
19	from pyscaffold.warnings import UpdateNotSupported	1✔
20
21	from . import templates	1✔
22
23	django_admin = ShellCommand("django-admin.py")	1✔
24
25
26	class Django(Extension):	1✔
27	"""Generate Django project files"""
28
29	mutually_exclusive = True	1✔
30
31	try:	1✔
32	# TODO: Remove this try/except block on PyScaffold >= 4.x
33	from pyscaffold.extensions import django # Check if django is a builtin	1✔
34
35	del django	1✔
36
37	# WORKAROUND:
38	#
39	# This avoids raising an error by using `add_argument` with an
40	# option/flag that was already used and at the same time provides
41	# a unequivocal way of accessing the newest implementation in the
42	# tests via the `--x-` prefix.
43	#
44	# For the time being this is useful to run against an existing
45	# version of PyScaffold that have an old implementation of this
46	# extension built into the core of the system. Once the builtin
47	# extension is removed in future versions, the following overwriting
48	# of the augment_cli method is not required.
49
50	def augment_cli(self, parser):	1✔
51	parser.add_argument(	1✔
52	self.xflag,
53	help="Newest version of `{}`, in development".format(self.flag),
54	dest="extensions",
55	action="append_const",
56	const=self,
57	)
58
59	# TODO: Remove on PyScaffold 4.x
60	@property	1✔
61	def xflag(self):
62	return "--x-" + self.flag.strip("-")	1✔
63
64	except ImportError:	×
65	pass # Never mind, we are in a recent version of PyScaffold	×
66
67	def activate(self, actions):	1✔
68	"""Register hooks to generate project using django-admin.
69
70	Args:
71	actions (list): list of actions to perform
72
73	Returns:
74	list: updated list of actions
75	"""
76
77	# `get_default_options` uses passed options to compute derived ones,
78	# so it is better to prepend actions that modify options.
79	actions = helpers.register(	1✔
80	actions, enforce_django_options, before="get_default_options"
81	)
82	# `apply_update_rules` uses CWD information,
83	# so it is better to prepend actions that modify it.
84	actions = helpers.register(	1✔
85	actions, create_django_proj, before="apply_update_rules"
86	)
87
88	return actions + [instruct_user]	1✔
89
90
91	def enforce_django_options(struct, opts):	1✔
92	"""Make sure options reflect the Django usage.
93
94	Args:
95	struct (dict): project representation as (possibly) nested
96	:obj:`dict`.
97	opts (dict): given options, see :obj:`create_project` for
98	an extensive list.
99
100	Returns:
101	struct, opts: updated project representation and options
102	"""
103	opts["package"] = opts["project"] # required by Django	1✔
104	opts["force"] = True	1✔
105	opts.setdefault("requirements", []).append("django")	1✔
106
107	return struct, opts	1✔
108
109
110	def create_django_proj(struct, opts):	1✔
111	"""Creates a standard Django project with django-admin.py
112
113	Args:
114	struct (dict): project representation as (possibly) nested
115	:obj:`dict`.
116	opts (dict): given options, see :obj:`create_project` for
117	an extensive list.
118
119	Returns:
120	struct, opts: updated project representation and options
121
122	Raises:
123	:obj:`RuntimeError`: raised if django-admin.py is not installed
124	"""
125	if opts.get("update"):	1✔
126	helpers.logger.warning(UpdateNotSupported(extension="django"))	1✔
127	return struct, opts	1✔
128
129	try:	1✔
130	django_admin("--version")	1✔
131	except Exception as e:	1✔
132	raise DjangoAdminNotInstalled from e	1✔
133
134	# TODO: replace project with project_path / name in PyScaffold 4.x
135
136	pretend = opts.get("pretend")	1✔
137	project_path = Path(opts["project"])	1✔
138	pkg_name = opts["project"]	1✔
139
140	django_admin("startproject", str(project_path), log=True, pretend=pretend)	1✔
141
142	src_dir = project_path / "src"	1✔
143	pkg_dir = src_dir / pkg_name	1✔
144	orig_dir = project_path / pkg_name	1✔
145
146	if not pretend:	1✔
147	src_dir.mkdir(exist_ok=True)	1✔
148	orig_dir.rename(pkg_dir)	1✔
149	helpers.logger.report("move", orig_dir, target=pkg_dir)	1✔
150
151	manage = project_path / "manage.py"	1✔
152	main = pkg_dir / "__main__.py"	1✔
153
154	if not pretend:	1✔
155	manage.rename(main)	1✔
156	helpers.logger.report("move", manage, target=main)	1✔
157
158	settings = pkg_dir / "settings.py"	1✔
159	replace_default_database(helpers.logger, settings, pretend=pretend)	1✔
160
161	if not pretend:	1✔
162	manage.write_text(templates.manage(opts))	1✔
163	manage.chmod(manage.stat().st_mode \| stat.S_IXUSR)	1✔
164	helpers.logger.report("create", manage)	1✔
165	helpers.logger.report("chmod", "+x {}".format(manage))	1✔
166
167	struct = helpers.modify(	1✔
168	struct,
169	project_path / ".gitignore",
170	lambda contents: "{}\n\n# Django\n/*.sqlite3".format(contents),
171	)
172
173	return struct, opts	1✔
174
175
176	def instruct_user(struct, opts):	1✔
177	logger.warning(	1✔
178	"\nDjango is used to create web applications while PyScaffold makes it "
179	"easy to create re-usable Python (pip) packages, such as libraries.\n"
180	"There is nothing wrong with trying to distribute your web application "
181	"as an installable package, but you have to be aware about the changes "
182	"in mindset. Please check the official docs in\n\n"
183	"\thttps://pyscaffold.org/projects/django\n\n"
184	"for more information.\n"
185	)
186
187	return struct, opts	1✔
188
189
190	PATTERN = re.compile(r"os\.path\.join\(BASE_DIR, ['\"]db\.sqlite3['\"]\)")	1✔
191	REPLACEMENT = 'os.path.join(os.path.dirname(BASE_DIR), "db.sqlite3")'	1✔
192
193
194	def replace_default_database(	1✔
195	logger, file_path, pattern=PATTERN, replacement=REPLACEMENT, pretend=False
196	):
197	exception = DjangoVersionMightBeUnsupported(	1✔
198	"Failed attempt to replace the default sqlite3 database file with "
199	"{} in {}.".format(REPLACEMENT, file_path)
200	)
201
202	try:	1✔
203	if not pretend:	1✔
204	text = file_path.read_text()	1✔
205	replaced, n = pattern.subn(replacement, text)	1✔
206	if n < 1:	1!
207	# No substitution was made, there is something wrong with the
208	# assumptions on how the file should be.
209	raise SystemError(text)	×
210	raise exception	×
211	file_path.write_text(replaced)	1✔
212	logger.report("replace", "default database in {}".format(file_path))	1✔
213	except PyScaffoldDjangoError:	×
214	raise	×
215	except Exception as ex:	×
216	raise exception from ex	×
217
218
219	class PyScaffoldDjangoError(RuntimeError):	1✔
220	"""Base class for all the exceptions in this package"""
221
222
223	class DjangoVersionMightBeUnsupported(PyScaffoldDjangoError):	1✔
224	"""The files generated by django-admin.py are different from expected."""
225
226	EXTRA = (	1✔
227	"\nA possible reason for that is that a new version of Django is "
228	"incompatible with pyscaffoldext-django.\n"
229	"Please visit the documentation in https://pyscaffold.org/projects/django "
230	"and follow the steps to integrate django manually.\n"
231	"Please also consider submitting a pull request with the fix."
232	)
233
234	def __init__(self, message=None, args, *kwargs):	1✔
235	message = (message or self.__class__.__doc__) + self.EXTRA	1✔
236	super(DjangoVersionMightBeUnsupported, self).__init__(message, args, *kwargs)	1✔
237
238
239	class DjangoAdminNotInstalled(PyScaffoldDjangoError):	1✔
240	"""This extension depends on the ``django-admin.py`` cli script."""
241
242	DEFAULT_MESSAGE = "django-admin.py is not installed, " "run: pip install django"	1✔
243
244	def __init__(self, message=DEFAULT_MESSAGE, args, *kwargs):	1✔
245	super(DjangoAdminNotInstalled, self).__init__(message, args, *kwargs)	1✔

pyscaffold / pyscaffoldext-django / 24

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous