cookiecutter.cookiecutter() - Code Metrics - Inspection of "Isolated file environments" - audreyr/cookiecutter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#623)

unknown

created 2015-12-28 07:57 UTC

cookiecutter.cookiecutter() C

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	73
rs	5.5062
cc	7

How to fix Long Method

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
cookiecutter.main
-----------------

Main entry point for the `cookiecutter` command.

The code in this module is also a good example of how to use Cookiecutter as a
library rather than a script.
"""

from __future__ import unicode_literals

import logging

import os
import re

from .config import get_user_config, get_user_config_path
from .exceptions import InvalidModeException
from .generate import generate_context, generate_files
from .prompt import prompt_for_config
from .replay import dump, load
from .vcs import clone

logger = logging.getLogger(__name__)

builtin_abbreviations = {
    'gh': 'https://github.com/{0}.git',
    'bb': 'https://bitbucket.org/{0}',
}

REPO_REGEX = """
(
((git|ssh|https|http):(//)?)    # something like git:// ssh:// etc.
 |                              # or
 (\w+@[\w\.]+)                  # something like user@...
)
.*
"""


def is_repo_url(value):
    """Return True if value is a repository URL."""
    return bool(re.match(REPO_REGEX, value, re.VERBOSE))


def expand_abbreviations(template, config_dict):
    """
    Expand abbreviations in a template name.

    :param template: The project template name.
    :param config_dict: The user config, which will contain abbreviation
        definitions.
    """

    abbreviations = builtin_abbreviations.copy()
    abbreviations.update(config_dict.get('abbreviations', {}))

    if template in abbreviations:
        return abbreviations[template]

    # Split on colon. If there is no colon, rest will be empty
    # and prefix will be the whole template
    prefix, sep, rest = template.partition(':')
    if prefix in abbreviations:
        return abbreviations[prefix].format(rest)

    return template


def cookiecutter(
        template, checkout=None, no_input=False, extra_context=None,
        replay=False, overwrite_if_exists=False, output_dir='.',
        config_file=None):
    """
    API equivalent to using Cookiecutter at the command line.

    :param template: A directory containing a project template directory,
        or a URL to a git repository.
    :param checkout: The branch, tag or commit ID to checkout after clone.
    :param no_input: Prompt the user at command line for manual configuration?
    :param extra_context: A dictionary of context that overrides default
        and user configuration.
    :param: overwrite_if_exists: Overwrite the contents of output directory
        if it exists
    :param output_dir: Where to output the generated project dir into.
    :param config_file: User configuration file path.
    """
    if config_file is None:
        config_file = get_user_config_path()

    if replay and ((no_input is not False) or (extra_context is not None)):
        err_msg = (
            "You can not use both replay and no_input or extra_context "
            "at the same time."
        )
        raise InvalidModeException(err_msg)

    # Get user config from ~/.cookiecutterrc or equivalent
    # If no config file,
    #   sensible defaults from config.get_default_config() are used
    config_dict = get_user_config(config_file=config_file)

    template = expand_abbreviations(template, config_dict)

    if is_repo_url(template):
        repo_dir = clone(
            repo_url=template,
            checkout=checkout,
            clone_to_dir=config_dict['cookiecutters_dir'],
            no_input=no_input
        )
    else:
        # If it's a local repo, no need to clone or copy to your
        # cookiecutters_dir
        repo_dir = template

    template_name = os.path.basename(template)

    if replay:
        context = load(config_dict['replay_dir'], template_name)
    else:
        context_file = os.path.join(repo_dir, 'cookiecutter.json')
        logging.debug('context_file is {0}'.format(context_file))

        context = generate_context(
            context_file=context_file,
            default_context=config_dict['default_context'],
            extra_context=extra_context,
        )

        # prompt the user to manually configure at the command line.
        # except when 'no-input' flag is set
        context['cookiecutter'] = prompt_for_config(context, no_input)

        dump(config_dict['replay_dir'], template_name, context)

    # Create project from local context and project template.
    return generate_files(
        repo_dir=repo_dir,
        context=context,
        overwrite_if_exists=overwrite_if_exists,
        output_dir=output_dir
    )


1			#!/usr/bin/env python
2			# -- coding: utf-8 --
3
4			"""
5			cookiecutter.main
6			-----------------
7
8			Main entry point for the `cookiecutter` command.
9
10			The code in this module is also a good example of how to use Cookiecutter as a
11			library rather than a script.
12			"""
13
14			from __future__ import unicode_literals
15
16			import logging
17
18			import os
19			import re
20
21			from .config import get_user_config, get_user_config_path
22			from .exceptions import InvalidModeException
23			from .generate import generate_context, generate_files
24			from .prompt import prompt_for_config
25			from .replay import dump, load
26			from .vcs import clone
27
28			logger = logging.getLogger(__name__)
29
30			builtin_abbreviations = {
31			'gh': 'https://github.com/{0}.git',
32			'bb': 'https://bitbucket.org/{0}',
33			}
34
35			REPO_REGEX = """
36			(
37			((git\|ssh\|https\|http):(//)?) # something like git:// ssh:// etc.
38			\| # or
39			(\w+@[\w\.]+) # something like user@...
40			)
41			.*
42			"""
43
44
45			def is_repo_url(value):
46			"""Return True if value is a repository URL."""
47			return bool(re.match(REPO_REGEX, value, re.VERBOSE))
48
49
50			def expand_abbreviations(template, config_dict):
51			"""
52			Expand abbreviations in a template name.
53
54			:param template: The project template name.
55			:param config_dict: The user config, which will contain abbreviation
56			definitions.
57			"""
58
59			abbreviations = builtin_abbreviations.copy()
60			abbreviations.update(config_dict.get('abbreviations', {}))
61
62			if template in abbreviations:
63			return abbreviations[template]
64
65			# Split on colon. If there is no colon, rest will be empty
66			# and prefix will be the whole template
67			prefix, sep, rest = template.partition(':')
68			if prefix in abbreviations:
69			return abbreviations[prefix].format(rest)
70
71			return template
72
73
74			def cookiecutter(
75			template, checkout=None, no_input=False, extra_context=None,
76			replay=False, overwrite_if_exists=False, output_dir='.',
77			config_file=None):
78			"""
79			API equivalent to using Cookiecutter at the command line.
80
81			:param template: A directory containing a project template directory,
82			or a URL to a git repository.
83			:param checkout: The branch, tag or commit ID to checkout after clone.
84			:param no_input: Prompt the user at command line for manual configuration?
85			:param extra_context: A dictionary of context that overrides default
86			and user configuration.
87			:param: overwrite_if_exists: Overwrite the contents of output directory
88			if it exists
89			:param output_dir: Where to output the generated project dir into.
90			:param config_file: User configuration file path.
91			"""
92			if config_file is None:
93			config_file = get_user_config_path()
94
95			if replay and ((no_input is not False) or (extra_context is not None)):
96			err_msg = (
97			"You can not use both replay and no_input or extra_context "
98			"at the same time."
99			)
100			raise InvalidModeException(err_msg)
101
102			# Get user config from ~/.cookiecutterrc or equivalent
103			# If no config file,
104			# sensible defaults from config.get_default_config() are used
105			config_dict = get_user_config(config_file=config_file)
106
107			template = expand_abbreviations(template, config_dict)
108
109			if is_repo_url(template):
110			repo_dir = clone(
111			repo_url=template,
112			checkout=checkout,
113			clone_to_dir=config_dict['cookiecutters_dir'],
114			no_input=no_input
115			)
116			else:
117			# If it's a local repo, no need to clone or copy to your
118			# cookiecutters_dir
119			repo_dir = template
120
121			template_name = os.path.basename(template)
122
123			if replay:
124			context = load(config_dict['replay_dir'], template_name)
125			else:
126			context_file = os.path.join(repo_dir, 'cookiecutter.json')
127			logging.debug('context_file is {0}'.format(context_file))
128
129			context = generate_context(
130			context_file=context_file,
131			default_context=config_dict['default_context'],
132			extra_context=extra_context,
133			)
134
135			# prompt the user to manually configure at the command line.
136			# except when 'no-input' flag is set
137			context['cookiecutter'] = prompt_for_config(context, no_input)
138
139			dump(config_dict['replay_dir'], template_name, context)
140
141			# Create project from local context and project template.
142			return generate_files(
143			repo_dir=repo_dir,
144			context=context,
145			overwrite_if_exists=overwrite_if_exists,
146			output_dir=output_dir
147			)
148

audreyr / cookiecutter

Pull Request — master (#623)

cookiecutter.cookiecutter() C

Complexity

Size

Duplication

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like