Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
Cookiecutter flask
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Remy Mudingay
Cookiecutter flask
Commits
154e2490
Commit
154e2490
authored
5 years ago
by
James Curtin
Committed by
James Curtin
5 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Warn when running Cookiecutter with incompatible python version
parent
1e34130a
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
hooks/__init__.py
+0
-0
0 additions, 0 deletions
hooks/__init__.py
hooks/pre_gen_project.py
+25
-20
25 additions, 20 deletions
hooks/pre_gen_project.py
hooks/utils.py
+19
-0
19 additions, 0 deletions
hooks/utils.py
with
44 additions
and
20 deletions
hooks/__init__.py
0 → 100644
+
0
−
0
View file @
154e2490
This diff is collapsed.
Click to expand it.
hooks/pre_gen_project.py
+
25
−
20
View file @
154e2490
...
...
@@ -2,37 +2,42 @@ import logging
import
re
import
sys
LOGGER
=
logging
.
getLogger
()
MODULE_REGEX
=
r
"
^[_a-zA-Z][_a-zA-Z0-9]+$
"
class
bcolors
:
WARNING
=
"
\033
[93m
"
ENDC
=
"
\033
[0m
"
BOLD
=
"
\033
[1m
"
# Provide ability to import from the `hooks` directory
sys
.
path
.
append
(
"
..
"
)
def
colorize
(
escape_code
,
text
):
code
=
getattr
(
bcolors
,
escape_code
)
return
f
"
{
code
}{
text
}{
bcolors
.
ENDC
}
"
logging
.
basicConfig
()
LOGGER
=
logging
.
getLogger
(
__name__
)
MODULE_REGEX
=
r
"
^[_a-zA-Z][_a-zA-Z0-9]+$
"
def
log_warning
(
module_name
):
def
check_python_version
():
python_major_version
=
sys
.
version_info
[
0
]
python_minor_version
=
sys
.
version_info
[
1
]
# Must remain compatible with Python 2 to provide useful error message.
warning
=
(
f
"
\n
{
colorize
(
'
WARNING
'
,
'
WARNING
:
'
)
}
{
colorize
(
'
BOLD
'
,
module_name
)
}
"
"
is not a valid Python module name!
\n
"
"
See https://www.python.org/dev/peps/pep-0008/#package-and-module-names
"
"
for naming standards.
\n
"
)
LOGGER
.
warning
(
warning
)
"
\n
WARNING: You are running cookiecutter using
"
"
Python {}.{}, but a version >= Python 3.6+ is required.
\n
"
"
Either install a more recent version of Python, or use the Docker instructions.
\n
"
).
format
(
python_major_version
,
python_minor_version
)
if
(
python_major_version
==
2
)
or
(
python_major_version
==
3
and
python_minor_version
<
6
):
LOGGER
.
warning
(
warning
)
sys
.
exit
(
1
)
def
validate_python_module_name
():
module_name
=
"
{{ cookiecutter.app_name }}
"
if
not
re
.
match
(
MODULE_REGEX
,
module_name
):
log_warning
(
module_name
)
log_
module_name_
warning
(
module_name
,
LOGGER
)
sys
.
exit
(
1
)
if
__name__
==
"
__main__
"
:
check_python_version
()
# Import after validating Python version to prevent confusing SyntaxError
# for users with incompatible Python versions.
from
hooks.utils
import
log_module_name_warning
validate_python_module_name
()
This diff is collapsed.
Click to expand it.
hooks/utils.py
0 → 100644
+
19
−
0
View file @
154e2490
class
bcolors
:
WARNING
=
"
\033
[93m
"
ENDC
=
"
\033
[0m
"
BOLD
=
"
\033
[1m
"
def
colorize
(
escape_code
,
text
):
code
=
getattr
(
bcolors
,
escape_code
)
return
f
"
{
code
}{
text
}{
bcolors
.
ENDC
}
"
def
log_module_name_warning
(
module_name
,
logger
):
warning
=
(
f
"
\n
{
colorize
(
'
WARNING
'
,
'
WARNING
:
'
)
}
{
colorize
(
'
BOLD
'
,
module_name
)
}
"
"
is not a valid Python module name!
\n
"
"
See https://www.python.org/dev/peps/pep-0008/#package-and-module-names
"
"
for naming standards.
\n
"
)
logger
.
warning
(
warning
)
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment