xinb
/
zsh-completions
mirror of https://github.com/zsh-users/zsh-completions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge 0356cd93a5 into e09fa74f2d

This commit is contained in:
Daniel Hahler 2016-08-16 20:07:06 +00:00 committed by GitHub
parent e09fa74f2d 0356cd93a5
commit 0da61579b9
1 changed files with 324 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

402
src/_manage.py
View File

@ -1,51 +1,151 @@
#compdef manage.py django-admin.py #compdef manage.py django-manage django-admin.py django-admin
# ------------------------------------------------------------------------------ # vim:ft=zsh sw=2:
# Description
# -----------
# #
# Completion script for Django's manage.py (https://www.djangoproject.com). # Completion script for Django's manage.py (https://www.djangoproject.com).
# #
# Source: https://github.com/technolize/zsh-completion-funcs # NOTE: Django provides simple autocompletion, through e.g.:
# #
# ------------------------------------------------------------------------------ # DJANGO_AUTO_COMPLETE=1 COMP_WORDS="manage.py runserver" COMP_CWORD=2 ./manage.py
# Authors
# -------
# #
# * technolize (https://github.com/technolize) # TODO: rename to _django, move to zsh
#
# ------------------------------------------------------------------------------
# Store $word[1] as manage_cmd to be used for callbacks.
# TODO: rename (__django_cmd?)
_managepy_cmd=$commands[${words[1]}]
if [[ -z $_managepy_cmd ]]; then
_managepy_cmd=${words[1]}
fi
_managepy-cleanup(){} # Get completions through Django's completion system.
_managepy-compilemessages(){} # Used as a fallback only, because it's slow.
_managepy_get_django_completion() {
local -a cmd
local ret
django_completion=($(_call_program django-completions \
env PYTHONWARNINGS="ignore::DeprecationWarning" \
DJANGO_AUTO_COMPLETE=1 COMP_WORDS=\"$_managepy_cmd $1\" \
COMP_CWORD=$2 $_managepy_cmd))
# ret=$?
# XXX: Django exits with 1 always for completions!
# (fixed in Django 1.10, https://code.djangoproject.com/ticket/25420).
ret=0
if [[ $#django_completion == 0 ]]; then
zle -M "There was an error querying Django (using $_managepy_cmd)!"
ret=1
fi
return $ret
}
typeset -ga nul_args
nul_args=(
'--verbosity=-[verbosity level; 0=minimal output, 1=normal output, 2=all output.]:Verbosity:((0\:minimal 1\:normal 2\:all))'
'--settings=-[the Python path to a settings module.]:file:_files'
'--pythonpath=-[a directory to add to the Python path.]:directory:_directories'
'--traceback[print traceback on exception.]'
"--no-color[Don't colorize the command output.]"
"--version[show program's version number and exit.]"
{-h,--help}'[show this help message and exit.]'
)
typeset -ga start_args
start_args=(
'--template=-[The path or URL to load the template from.]:directory:_directories'
'--extension=-[The file extension(s) to render (default: "py").]'
'--name=-[The file name(s) to render.]:file:_files'
)
typeset -ga db_args
db_args=(
'--database=-[Nominates a database. Defaults to the "default" database.]'
)
typeset -ga noinput_args
noinput_args=(
'--noinput[tells Django to NOT prompt the user for input of any kind.]'
)
typeset -ga no_init_data_args
no_init_data_args=(
'--no-initial-data[Tells Django not to load any initial data after database synchronization.]'
)
typeset -ga tag_args
tag_args=(
'--tag=-[Run only checks labeled with given tag.]'
'--list-tags[List available tags.]'
)
_managepy-check(){
_arguments -s : \
$tag_args \
$nul_args && ret=0
}
_managepy-changepassword(){
_arguments -s : \
$db_args \
$nul_args && ret=0
}
_managepy-createcachetable(){ _managepy-createcachetable(){
_arguments -s : \ _arguments -s : \
$db_args \
$nul_args && ret=0
}
_managepy-createsuperuser(){
_arguments -s : \
'--username=-[Specifies the login for the superuser.]' \
'--email=-[Specifies the email for the superuser.]' \
$noinput_args \
$db_args \
$nul_args && ret=0
}
_managepy-collectstatic(){
_arguments -s : \
'--link[Create a symbolic link to each file instead of copying.]' \
'--no-post-process[Do NOT post process collected files.]' \
'--ignore=-[Ignore files or directories matching this glob-style pattern. Use multiple times to ignore more.]' \
'--dry-run[Do everything except modify the filesystem.]' \
'--clear[Clear the existing files using the storage before trying to copy or link the original file.]' \
'--link[Create a symbolic link to each file instead of copying.]' \
'--no-default-ignore[Do not ignore the common private glob-style patterns "CVS", ".*" and "*~".]' \
$noinput_args \
$nul_args && ret=0 $nul_args && ret=0
} }
_managepy-dbshell(){ _managepy-dbshell(){
_arguments -s : \ _arguments -s : \
$db_args \
$nul_args && ret=0 $nul_args && ret=0
} }
_managepy-diffsettings(){ _managepy-diffsettings(){
_arguments -s : \ _arguments -s : \
"--all[Display all settings, regardless of their value.]"
$nul_args && ret=0 $nul_args && ret=0
} }
_managepy-dumpdata(){ _managepy-dumpdata(){
_arguments -s : \ _arguments -s : \
'--format=-[specifies the output serialization format for fixtures.]:format:(json yaml xml)' \ '--format=-[Specifies the output serialization format for fixtures.]:format:(json yaml xml)' \
'--indent=-[specifies the indent level to use when pretty-printing output.]:' \ '--indent=-[Specifies the indent level to use when pretty-printing output.]' \
'--exclude=-[An app_label or app_label.ModelName to exclude (use multiple --exclude to exclude multiple apps/models).]' \
'--natural-foreign[Use natural foreign keys if they are available.]' \
'--natural-primary[Use natural primary keys if they are available.]' \
"--all[Use Django's base manager to dump all models stored in the database.]" \
'--pks=-[Only dump objects with given primary keys.]' \
$db_args \
$nul_args \ $nul_args \
'*::appname:_applist' && ret=0 '*::appname:_applist' && ret=0
} }
_managepy-flush(){ _managepy-flush(){
_arguments -s : \ _arguments -s : \
'--verbosity=-[verbosity level; 0=minimal output, 1=normal output, 2=all output.]:Verbosity:((0\:minimal 1\:normal 2\:all))' \ $no_init_data_args \
'--noinput[tells Django to NOT prompt the user for input of any kind.]' \ $db_args \
$noinput_args \
$nul_args && ret=0 $nul_args && ret=0
} }
@ -58,29 +158,57 @@ _managepy-help(){
_managepy_cmds(){ _managepy_cmds(){
local line local line
local -a cmd local -a cmd
_call_program help-command ./manage.py help \ _call_program help-command $_managepy_cmd help \
|& sed -n '/^ /s/[(), ]/ /gp' \ 2>/dev/null| sed -n '/^ /s/[(), ]/ /gp' \
| while read -A line; do cmd=($line $cmd) done | while read -A line; do cmd=($line $cmd) done
_describe -t managepy-command 'manage.py command' cmd _describe -t managepy-command 'manage.py command' cmd
} }
_managepy-inspectdb(){ _managepy-inspectdb(){
_arguments -s : \ _arguments -s : \
$db_args \
$nul_args && ret=0 $nul_args && ret=0
} }
_managepy-loaddata(){ _managepy-loaddata(){
_arguments -s : \ _arguments -s : \
'--verbosity=-[verbosity level; 0=minimal output, 1=normal output, 2=all output.]:Verbosity:((0\:minimal 1\:normal 2\:all))' \ '--ignorenonexistent[Ignores entries in the serialized data for fields that do not currently exist on the model.]' \
'--app=-[Only look for fixtures in the specified app.]:appname:_applist' \
'*::file:_files' \ '*::file:_files' \
$db_args \
$nul_args && ret=0 $nul_args && ret=0
} }
_managepy-makemessages(){} _managepy-makemessages(){
_managepy-reset(){
_arguments -s : \ _arguments -s : \
'--noinput[tells Django to NOT prompt the user for input of any kind.]' \ '--locale=-[Creates or updates the message files for the given locale(s) (e.g. pt_BR).]' \
'--domain=-[The domain of the message files (default: "django").]' \
'--all[Updates the message files for all existing locales.]' \
'--extension=-[The file extension(s) to examine (default: "html,txt", or "js" if the domain is "djangojs").]' \
'--symlinks[Follows symlinks to directories when examining source code and templates for translation strings.]' \
'--ignore=-[Ignore files or directories matching this glob-style pattern.]' \
"--no-default-ignore[Don't ignore the common glob-style patterns 'CVS', '.*', '*~' and '*.pyc'.]" \
"--no-wrap[Don't break long message lines into several lines.]" \
"--no-location[Don't write '#: filename:line' lines.]" \
'--no-obsolete[emove obsolete message strings.]' \
'--keep-pot[Keep .pot file after making messages.]' \
$nul_args && ret=0
}
_managepy-makemigrations(){
_arguments -s : \
'--dry-run[Just show what migrations would be made]' \
'--merge[Enable fixing of migration conflicts.]' \
'--empty[Create an empty migration.]' \
$noinput_args \
$nul_args && ret=0
}
_managepy-migrate(){
_arguments -s : \
'--fake[Mark migrations as run without actually running them]' \
'--list[Show a list of all known migrations and which are applied]' \
$no_init_data_args \
$noinput_args \
$db_args \
'*::appname:_applist' \ '*::appname:_applist' \
$nul_args && ret=0 $nul_args && ret=0
} }
@ -113,80 +241,164 @@ _managepy-runfcgi(){
_managepy-runserver(){ _managepy-runserver(){
_arguments -s : \ _arguments -s : \
'--noreload[tells Django to NOT use the auto-reloader.]' \ '--ipv6[use an IPv6 address]' \
'--adminmedia[specifies the directory from which to serve admin media.]:directory:_files' \ '--nothreading[do not threading]' \
'--noreload[do not use the auto-reloader]' \
'--nostatic[do not automatically serve static files at STATIC_URL]' \
'--insecure[serve static files even if DEBUG is False]' \
$nul_args && ret=0 $nul_args && ret=0
} }
_managepy-shell(){ _managepy-shell(){
_arguments -s : \ _arguments -s : \
'--plain[tells Django to use plain Python, not IPython.]' \ '--plain[tells Django to use plain Python, not IPython.]' \
'--no-startup[When using plain Python, ignore the PYTHONSTARTUP environment variable and ~/.pythonrc.py script.]' \
'--interface=-[Specify an interactive interpreter interface.]:INTERFACE:((ipython bpython))' \
$nul_args && ret=0 $nul_args && ret=0
} }
_managepy-sql(){} _managepy-sql(){
_managepy-sqlall(){} _arguments -s : \
_managepy-sqlclear(){} $db_args \
_managepy-sqlcustom(){} $nul_args && ret=0
_managepy-sqlflush(){} }
_managepy-sqlindexes(){}
_managepy-sqlinitialdata(){}
_managepy-sqlreset(){}
_managepy-sqlsequencereset(){}
_managepy-startapp(){}
_managepy-sqlall(){
_arguments -s : \
$db_args \
$nul_args && ret=0
}
_managepy-sqlclear(){
_arguments -s : \
$db_args \
$nul_args && ret=0
}
_managepy-sqlcustom(){
_arguments -s : \
$db_args \
$nul_args && ret=0
}
_managepy-dropindexes(){
_arguments -s : \
$db_args \
$nul_args && ret=0
}
_managepy-sqlflush(){
_arguments -s : \
$db_args \
$nul_args && ret=0
}
_managepy-sqlindexes(){
_arguments -s : \
$db_args \
$nul_args && ret=0
}
_managepy-sqlinitialdata(){
_arguments -s : \
$nul_args && ret=0
}
_managepy-sqlsequencereset(){
_arguments -s : \
$db_args \
$nul_args && ret=0
}
_managepy-squashmigrations(){
_arguments -s : \
'--no-optimize[Do not try to optimize the squashed operations.]' \
$noinput_args \
$nul_args && ret=0
}
_managepy-startapp(){
_arguments -s : \
$start_args \
$nul_args && ret=0
}
_managepy-startproject(){ _managepy-startproject(){
_arguments -s : \ _arguments -s : \
"(-v --verbosity)"{-v,--verbosity}"[Verbosity level; 0=minimal output, 1=normal output, 2=verbose output, 3=very verbose output.]:Verbosity:((0\:minimal 1\:normal 2\:verbose 4\:very\ verbose))" \ $start_args \
'--template[The path or URL to load the template from.]:file:_files' \ $nul_args && ret=0
"(-e --extension)"{-e,--extension}"[The file extension(s) to render (default: "py"). Separate multiple extensions with commas, or use -e multiple times.]" \
"(-n --name)"{-n,--name}"[The file name(s) to render. Separate multiple extensions with commas, or use -n multiple times. --version show program\'s version number and exit]:file:_files" \
$nul_args \
'*::args:_gnu_generic'
} }
_managepy-syncdb() { _managepy-syncdb() {
_arguments -s : \ _arguments -s : \
'--verbosity=-[verbosity level; 0=minimal output, 1=normal output, 2=all output.]:Verbosity:((0\:minimal 1\:normal 2\:all))' \ $noinput_args \
'--noinput[tells Django to NOT prompt the user for input of any kind.]' \ $no_init_data_args \
$db_args \
$nul_args && ret=0 $nul_args && ret=0
} }
_managepy-test() { _managepy-test() {
_arguments -s : \ _arguments -s : \
'--verbosity=-[verbosity level; 0=minimal output, 1=normal output, 2=all output.]:Verbosity:((0\:minimal 1\:normal 2\:all))' \ '--failfast[Tells Django to stop running the test suite after first failed test.]' \
'--noinput[tells Django to NOT prompt the user for input of any kind.]' \ '--testrunner=-[Tells Django to use specified test runner class instead of the one specified by the TEST_RUNNER setting.]' \
'--liveserver=-[Overrides the default address where the live server (used with LiveServerTestCase) is expected to run from. The default value is localhost:8081.]' \
'--top-level-directory=-[Top level of project for unittest discovery.]' \
'--pattern=-[The test matching pattern. Defaults to test*.py.]:' \
$noinput_args \
'*::appname:_applist' \ '*::appname:_applist' \
$nul_args && ret=0 $nul_args && ret=0
} }
_managepy-testserver() { _managepy-testserver() {
_arguments -s : \ _arguments -s : \
'--verbosity=-[verbosity level; 0=minimal output, 1=normal output, 2=all output.]:Verbosity:((0\:minimal 1\:normal 2\:all))' \
'--addrport=-[port number or ipaddr:port to run the server on.]' \ '--addrport=-[port number or ipaddr:port to run the server on.]' \
'--ipv6[Tells Django to use an IPv6 address.]' \
$noinput_args \
'*::fixture:_files' \ '*::fixture:_files' \
$nul_args && ret=0 $nul_args && ret=0
} }
_managepy-validate() { _managepy-validate() {
_arguments -s : \ _arguments -s : \
$tag_args \
$nul_args && ret=0 $nul_args && ret=0
} }
_managepy-changepassword(){}
_managepy-createsuperuser(){}
_managepy-collectstatic(){}
_managepy-findstatic(){}
_managepy-commands() { __django_caching_policy()
{
local ret # 0 means that the cache needs to be rebuilt.
# Get python interpreter from manage.py script.
local python
python=$(head $_managepy_cmd | head -n1 | cut -b3-) #!/usr/bin/env python
# Check that it refers to "python", it might be "#!/usr/bin/env bash" with
# pyenv.
if ! [[ $python == *python* ]]; then
python=python
fi
# Compare cache file's timestamp to the most recently modified sys.path entry.
# This gets changed/touched when installing/removing packages.
local newest_sys_path=$($=python -c '
import sys
from os.path import exists, getmtime
print(sorted(sys.path, key=lambda x: exists(x) and getmtime(x))[-1])')
[[ $newest_sys_path -nt $1 ]]
ret=$?
return $ret
}
_managepy_commands() {
local -a commands local -a commands
commands=( commands=(
'cleanup:Can be run as a cronjob or directly to clean out old data from the database (only expired sessions at the moment).' 'check:Checks the entire Django project for potential problems.'
'compilemessages:Compiles .po files to .mo files for use with builtin gettext support.' 'compilemessages:Compiles .po files to .mo files for use with builtin gettext support.'
'createcachetable:creates the table needed to use the SQL cache backend.' 'createcachetable:Creates the table needed to use the SQL cache backend.'
'dbshell:runs the command-line client for the current DATABASE_ENGINE.' 'dbshell:Runs the command-line client for the current DATABASE_ENGINE.'
"diffsettings:displays differences between the current settings.py and Django's default settings." "diffsettings:Displays differences between the current settings.py and Django's default settings."
'dumpdata:Output the contents of the database as a fixture of the given format.' 'dumpdata:Output the contents of the database as a fixture of the given format.'
'flush:Executes ``sqlflush`` on the current database.' 'flush:Executes ``sqlflush`` on the current database.'
'help:manage.py help.' 'help:manage.py help.'
@ -209,7 +421,6 @@ _managepy-commands() {
'sqlindexes:Prints the CREATE INDEX SQL statements for the given model module name(s).' 'sqlindexes:Prints the CREATE INDEX SQL statements for the given model module name(s).'
'sqlmigrate:Prints the SQL for the named migration.' 'sqlmigrate:Prints the SQL for the named migration.'
"sqlinitialdata:RENAMED: see 'sqlcustom'" "sqlinitialdata:RENAMED: see 'sqlcustom'"
'sqlreset:Prints the DROP TABLE SQL, then the CREATE TABLE SQL, for the given app name(s).'
'sqlsequencereset:Prints the SQL statements for resetting sequences for the given app name(s).' 'sqlsequencereset:Prints the SQL statements for resetting sequences for the given app name(s).'
'squashmigrations:Squashes the migrations for app_label up to and including migration_name down into fewer migrations.' 'squashmigrations:Squashes the migrations for app_label up to and including migration_name down into fewer migrations.'
"startapp:Creates a Django app directory structure for the given app name in this project's directory." "startapp:Creates a Django app directory structure for the given app name in this project's directory."
@ -219,58 +430,83 @@ _managepy-commands() {
'testserver:Runs a development server with data from the given fixture(s).' 'testserver:Runs a development server with data from the given fixture(s).'
'validate:Validates all installed models.' 'validate:Validates all installed models.'
) )
if [[ $words[1] =~ "manage.py$" ]]; then if [[ $words[1] =~ "manage(.py)$" ]]; then
commands=($commands commands=($commands
"changepassword:Change a user's password for django.contrib.auth." "changepassword:Change a user's password for django.contrib.auth."
'createsuperuser:Used to create a superuser.' 'createsuperuser:create a superuser'
'collectstatic:Collect static files in a single location.' 'collectstatic:collect static files in a single location'
'findstatic:Finds the absolute paths for the given static file(s).' 'findstatic:finds the absolute paths for the given static file(s)'
) )
fi fi
_describe -t commands 'manage.py command' commands && ret=0 _describe -t commands 'manage.py command' commands && ret=0
# Query Django's completion for the full list of commands, using a cache.
local cache_policy
zstyle -s ":completion:${curcontext}:" cache-policy cache_policy
if [[ -z "$cache_policy" ]]; then
zstyle ":completion:${curcontext}:" cache-policy __django_caching_policy
fi
# Use cache name based on current script; there are usually different apps
# installed per project.
local cachename=django_subcommands${_managepy_cmd:a}
typeset -a django_completion
if ( [[ ${(P)+cachename} -eq 0 ]] || _cache_invalid $cachename ) \
&& ! _retrieve_cache $cachename; then
zle -M "Querying Django subcommands..."
local ret_djcomp
if _managepy_get_django_completion "" $((CURRENT-1)); then
# Remove any commands we have already.
local i idx val _django_subcommands
if [[ -n $django_completion ]]; then
for i in {1..$#django_completion}; do
val=${django_completion[$i]}
idx=${commands[(I)$val*]}
if [[ $idx == 0 ]]; then
_django_subcommands+=($val)
fi
done
fi
_store_cache $cachename _django_subcommands
fi
fi
if (( $#_django_subcommands )); then
_describe -t commands-from-django 'manage.py command (from Django)' \
_django_subcommands && ret=0
fi
} }
_applist() { _applist() {
local line local line
local -a apps local -a apps
_call_program help-command "python -c \"import os.path as op, re, settings, sys;\\ # NOTE: this could use "$_managepy_cmd diffsettings --all", but that's slower.
_call_program help-command "python -c \"import os.path as op, re, django.conf, sys;\\
bn=op.basename(op.abspath(op.curdir));[sys\\ bn=op.basename(op.abspath(op.curdir));[sys\\
.stdout.write(str(re.sub(r'^%s\.(.*?)$' % .stdout.write(str(re.sub(r'^%s\.(.*?)$' %
bn, r'\1', i)) + '\n') for i in settings.\\ bn, r'\1', i)) + '\n') for i in django.conf.settings.\\
INSTALLED_APPS if re.match(r'^%s' % bn, i)]\"" \ INSTALLED_APPS if re.match(r'^%s' % bn, i)]\"" \
| while read -A line; do apps=($line $apps) done | while read -A line; do apps=($line $apps) done
_values 'Application' $apps && ret=0 _values 'Application' $apps && ret=0
} }
_manage.py() { _manage.py() {
local -a nul_args
nul_args=(
'--settings=-[the Python path to a settings module.]:file:_files'
'--pythonpath=-[a directory to add to the Python path.]::directory:_directories'
'--traceback[print traceback on exception.]'
"--version[show program's version number and exit.]"
{-h,--help}'[show this help message and exit.]'
)
local curcontext=$curcontext ret=1 local curcontext=$curcontext ret=1
if ((CURRENT == 2)); then if ((CURRENT == 2)); then
_managepy-commands _managepy_commands
else else
shift words shift words
(( CURRENT -- )) (( CURRENT -- ))
curcontext="${curcontext%:*:*}:managepy-$words[1]:" curcontext="${curcontext%:*:*}:managepy-$words[1]:"
_call_function ret _managepy-$words[1] if ! _call_function ret _managepy-$words[1]; then
_managepy_get_django_completion "$words[1,$CURRENT]" $((CURRENT))
_describe -t arguments-from-django 'manage.py subcommand arguments (from Django)' \
django_completion && ret=0
fi
fi fi
} }
_manage.py "$@" _manage.py "$@"
# Local Variables:
# mode: Shell-Script
# sh-indentation: 2
# indent-tabs-mode: nil
# sh-basic-offset: 2
# End:
# vim: ft=zsh sw=2 ts=2 et