cookiecutter.cookiecutter() - Code Metrics - Inspection of "Complain if we can't locate a local repository" - audreyr/cookiecutter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#652)

by Michael

created 2016-03-16 19:27 UTC

cookiecutter.cookiecutter() C

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
cc	7
dl	0
loc	74
rs	5.45

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, USER_CONFIG_PATH
from .exceptions import InvalidModeException, RepositoryNotFound
from .prompt import prompt_for_config
from .generate import generate_context, generate_files
from .vcs import clone
from .replay import dump, load

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=USER_CONFIG_PATH):
    """
    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 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.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

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

audreyr / cookiecutter

Pull Request — master (#652)

cookiecutter.cookiecutter() C

Complexity

Size

Duplication

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like