[docs]def print_report(results, unlintable_filenames, cant_lint_filenames,
broken_linter_names, unfindable_filenames, options={'bylinter': True}):
+
+
def base_file_cleaner(files):
+
return [file.replace(git_base + '/', '', 1) for file in files]
+
+
# ICK. Mutation, references, and hidden assignment.
+
def group_by(iterable, field_id):
+
results = []
+
keys = {}
+
for obj in iterable:
+
key = obj[field_id]
+
if key in keys:
+
keys[key].append(obj)
+
continue
+
keys[key] = [obj]
+
results.append((key, keys[key]))
+
return results
+
sort_position = 1
grouping = _('Linter: {}')
if 'byfile' in options:
diff --git a/objects.inv b/objects.inv
index 0d1f93b..39ab2d9 100644
Binary files a/objects.inv and b/objects.inv differ
diff --git a/searchindex.js b/searchindex.js
index a3f57f9..98438f4 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({envversion:49,filenames:["arguments","authors","contributing","git_lint","history","index","installation","manual","modules","readme","strategies","usage"],objects:{"":{git_lint:[3,0,0,"-"]},"git_lint.git_lint":{Linters:[3,1,1,""],MatchFilter:[3,1,1,""],StagingRunner:[3,1,1,""],WorkspaceRunner:[3,1,1,""],executable_exists:[3,4,1,""],find_config_file:[3,4,1,""],get_filelist:[3,4,1,""],get_git_base:[3,4,1,""],get_git_head:[3,4,1,""],get_git_response:[3,4,1,""],get_git_response_raw:[3,4,1,""],get_linter_status:[3,4,1,""],get_shell_response:[3,4,1,""],get_working_linter_names:[3,4,1,""],load_config:[3,4,1,""],run_git_command:[3,4,1,""],run_linters:[3,4,1,""],split_git_response:[3,4,1,""]},"git_lint.git_lint.Linters":{dryrun:[3,2,1,""],encode_shell_messages:[3,3,1,""],run_external_linter:[3,3,1,""],run_one_linter:[3,3,1,""]},"git_lint.git_lint.MatchFilter":{make_match_filter_matcher:[3,3,1,""]},"git_lint.option_handler":{cleanup_options:[3,4,1,""]},"git_lint.reporters":{base_file_cleaner:[3,4,1,""],group_by:[3,4,1,""],print_help:[3,4,1,""],print_linters:[3,4,1,""],print_report:[3,4,1,""],print_version:[3,4,1,""]},git_lint:{git_lint:[3,0,0,"-"],option_handler:[3,0,0,"-"],options:[3,0,0,"-"],reporters:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","staticmethod","Python static method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:staticmethod","4":"py:function"},terms:{"boolean":3,"class":3,"default":[0,7,10,11],"function":2,"long":[0,3,7,11],"new":[2,5],"public":6,"return":[3,7],"short":[0,7,11],"static":3,"true":[3,7],"while":9,about:2,accordingli:9,acknowledg:5,action:9,actual:[0,7,11],add:[2,10],against:[3,5,7,9],agre:9,all:[0,2,7,9,10,11],allow:3,along:3,alpha:9,alphanumer:7,also:9,alwai:2,ani:[3,7,9,10],any:2,anyth:[0,2,7,9,11],appear:[0,3,7,11],appreci:2,appropri:10,area:[0,5,7,9,11],argument:3,aris:9,articl:2,asciibetic:7,aside:7,associ:9,assum:9,assume:2,assur:5,author:9,automat:[5,9],avail:9,base:[0,3,7,9,10,11],base_file_clean:3,been:9,befor:[2,7],best:2,better:9,bin:11,bit:2,blog:2,both:9,branch:2,broken:9,broken_linter_nam:3,bugfix:2,build:9,byfil:[0,7,11],bylint:[0,3,7,11],can:[2,6,7,9,11],cant_lint_filenam:3,captur:10,care:11,central:9,chang:[0,2,5,7,9,10,11],check:[0,2,7,9,11],checker:9,checkout:2,chmod:11,choos:7,cleanup_opt:3,clone:[2,6,9],cmake:9,cmd:3,code:[3,7,9],com:[1,2,6,9],combin:3,comma:[0,7,11],command:[3,5,6,7,9,10],commandlin:3,comment:7,commit:[0,2,4,5,7,9,10],complet:[7,9],complex:9,condit:[3,7],config:[0,3,7,10,11],configur:[0,3,7,9,10,11],confus:9,connect:9,consequenti:9,contract:9,copi:[2,6,9],correspond:10,could:2,coupl:10,creat:[2,3,9],criteria:10,curl:6,current:[0,3,5,7,9,10,11],custom:9,damag:9,data:9,deem:9,delta:10,descript:2,detail:[2,7],determin:10,dictionari:3,differ:[7,10],direct:9,directli:9,directori:[0,3,6,7,9,10,11],directroi:10,disclaim:5,doc:[2,9],docstr:2,don:[0,6,7,9,11],done:2,down:[0,7,9,10,11],download:[6,11],driven:2,dryrun:[0,3,7,11],each:[3,7,9,10],easier:2,edit:9,either:[6,9],elf:1,elfsternberg:[2,6,9],encode_shell_messag:3,ensur:9,entir:9,error:[3,7],even:[2,7],event:9,everi:[0,2,7,11],everyth:9,exampl:6,exclud:[0,7,11],executable_exist:3,exit:10,experiment:11,explain:2,extens:[3,7,9],extra:3,extract:3,fact:9,fail:[0,3,7,10,11],failur:[3,7,10],field_id:3,file:[0,2,3,5,6,7,9,10,11],filenam:[3,7,11],filter:[3,10],find_config_fil:3,first:[0,1,7,11],fit:9,flake8:2,flip:7,follow:7,fork:2,found:3,free:9,from:[0,3,5],fullcmd:3,get_filelist:3,get_git_bas:3,get_git_head:3,get_git_respons:3,get_git_response_raw:3,get_linter_statu:3,get_shell_respons:3,get_working_linter_nam:3,git:[0,2,3,4],git_dir:[0,7,11],git_lint:2,github:[2,6,9,11],given:2,global:9,gmail:1,greatli:2,group:[0,7,11],group_bi:3,grunt:9,guid:6,have:[0,2,3,6,7,9,11],hell:4,help:[0,2,3,7,11],here:2,highli:9,home:[3,6,9,10],hook:[5,9],how:[2,9],http:[2,6,9],ide:9,identifi:[5,9],impli:9,includ:[2,7,9],index:5,indirect:9,individu:9,inform:[0,7,11],ini:7,inspir:9,instal:[2,6,9],install:[2,5],installat:5,issu:2,iter:3,just:[0,2,7,9,11],keep:[2,3],kenneth:1,label:3,let:7,letter:3,liabl:9,licens:9,life:9,like:9,line:[3,5,7,9,10],lint:[0,2,3,4],linter:[0,3,5,6,7,9,10,11],linter_nam:3,list:[0,2,3,7,10,11],littl:2,load:[3,10],load_config:3,local:2,locat:3,look:2,loss:9,mai:[6,9],make:[2,9],make_match_filter_match:3,mani:2,master:6,match:[3,7,10],matchfilt:3,materi:9,maxim:7,meet:2,merchant:9,messag:[0,3,7,10,11],might:[2,9],minu:7,mit:9,mkvirtualenv:2,mode:10,more:[0,2,7,11],most:9,mostli:9,move:4,name:[2,3],narrow:2,need:9,neglig:9,none:1,noth:3,now:2,npm:9,object:3,offici:2,once:6,one:3,onli:[0,3,7,9,10,11],only:9,open:2,oper:2,order:7,org:2,origin:2,other:[2,9],otherwis:[3,9],ought:9,out:[4,9],output:3,overriden:9,own:9,page:5,param:3,part:2,pass:[0,2,7,10,11],path:[0,7,11],per:[3,9],perform:[3,9],person:9,phase:10,pip:[2,6,9],plan:9,pleas:[2,6,11],possibl:[2,9],post:2,pre:[0,4,5,7,9,10],prefix:[3,7],print:[0,7,10,11],print_help:3,print_lint:3,print_report:3,print_vers:3,priorit:3,process:[3,6],produc:[0,7,11],profit:9,program:[5,9],project:[2,3,9,11],propos:2,provid:[5,9],prune:10,pulec:9,pull_request:2,push:2,put:2,pypi:2,python:[2,6,9],qualiti:[5,9],quiet:[0,7,11],readi:2,readme:[2,5],reason:9,receiv:3,recent:9,record:10,reduc:10,releas:5,rememb:2,replac:3,repo:[2,6,9],repodir:3,report:0,repositori:[3,5,6,7,9,10,11],reproduc:2,requir:9,restor:[9,10],result:[3,7,9,10],risk:9,root:3,rst:2,run:[0,2,3,5,6,7,9,10,11],run_external_lint:3,run_git_command:3,run_lint:3,run_one_lint:3,safeconfigpars:3,same:9,scan:[0,7,11],scope:2,script:3,search:5,second:[0,7,11],section:7,send:2,separ:[0,7,11],set:[2,3,7,9],setup:[2,6,9],shall:9,shell:9,should:2,show:[0,7,10,11],simpl:9,sinc:9,skip:[0,7,11],slightli:[0,7,11],softwar:9,some:9,sort:7,sourc:[3,5],special:9,specif:3,specifi:[3,7],split_git_respons:3,sponsor:9,stabl:5,stage:[0,5,7,9,10,11],stagingrunn:3,standard:7,stash:[9,10],statu:[7,10],step:2,sternberg:1,steve:9,still:9,string:3,style:[5,7,9],subset:2,substitut:3,succe:7,success:3,supersed:3,support:2,sure:2,syntax:[5,9],system:[2,9],tabl:3,tag:2,take:3,tarbal:6,termin:6,test:2,test_git_lint:2,text:[3,7],thei:[0,2,7,11],them:2,thi:[2,3,6,7,9,10],those:[0,3,7,11],through:[2,6],time:9,timestamp:[9,10],token:7,tortiou:9,touch:10,tox:2,travi:2,troubleshoot:2,tupl:3,understand:9,understood:9,unfindable_filenam:3,unlintable_filenam:3,unstag:10,updat:2,upon:9,usage:5,used:9,user:[3,9,10],vcs:9,verbos:[0,7,11],vers:7,version:[0,2,3,4,7,11],virtualenv:2,virtualenvwrapp:2,volunt:2,wai:[2,9],want:[2,9],warranti:9,web:2,websit:2,welcom:2,well:9,were:9,what:[0,7,9,10,11],whatev:9,whatsoev:9,when:[2,7,9],whether:[2,9],which:[3,7,10],whoever:2,why:[1,9],without:9,work:[2,7,9],workspac:[0,7,9,10,11],workspacerunn:3,would:[0,2,7,11],wrapper:9,wrong:9,yet:1,you:[2,6,7,9,11],your:[2,5,6,7,9],your_name_her:2,zero:7},titles:["<no title>","Credits","Contributing","git_lint package","History","Git Lint","Installation","git-lint(1)","git_lint","Git Lint: README","Strategies","Usage"],titleterms:{acknowledg:9,bug:2,command:11,commit:11,configuration:7,content:[3,11],contribut:2,contributor:1,credit:1,description:7,develop:1,disclaim:9,document:[2,9],featur:[2,9],feedback:2,fix:2,from:6,get:2,git:[5,7,9],git_lint:[3,8],guidelin:2,histori:4,hook:11,implement:2,indice:5,install:9,installat:6,lead:1,line:11,lint:[5,7,9],modul:3,name:7,option:[3,11],option_handl:3,options:7,output:7,packag:3,pre:11,pull:2,readme:9,releas:6,report:[2,3],request:2,sourc:6,stabl:6,start:2,strategi:10,submit:2,submodul:3,synopsis:7,tabl:5,tip:2,type:2,usage:[9,11],write:2}})
\ No newline at end of file
+Search.setIndex({envversion:49,filenames:["arguments","authors","contributing","git_lint","history","index","installation","manual","modules","readme","strategies","usage"],objects:{"":{git_lint:[3,0,0,"-"]},"git_lint.git_lint":{Linters:[3,1,1,""],MatchFilter:[3,1,1,""],StagingRunner:[3,1,1,""],WorkspaceRunner:[3,1,1,""],executable_exists:[3,4,1,""],get_filelist:[3,4,1,""],get_git_base:[3,4,1,""],get_git_head:[3,4,1,""],get_git_response:[3,4,1,""],get_git_response_raw:[3,4,1,""],get_linter_status:[3,4,1,""],get_shell_response:[3,4,1,""],load_config:[3,4,1,""],run_git_command:[3,4,1,""],run_linters:[3,4,1,""],split_git_response:[3,4,1,""]},"git_lint.git_lint.Linters":{dryrun:[3,2,1,""],encode_shell_messages:[3,3,1,""],run_external_linter:[3,3,1,""],run_one_linter:[3,3,1,""]},"git_lint.git_lint.MatchFilter":{make_match_filter_matcher:[3,3,1,""]},"git_lint.option_handler":{cleanup_options:[3,4,1,""]},"git_lint.reporters":{print_help:[3,4,1,""],print_linters:[3,4,1,""],print_report:[3,4,1,""],print_version:[3,4,1,""]},git_lint:{git_lint:[3,0,0,"-"],option_handler:[3,0,0,"-"],options:[3,0,0,"-"],reporters:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","staticmethod","Python static method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:staticmethod","4":"py:function"},terms:{"boolean":3,"class":3,"default":[0,7,10,11],"function":2,"long":[0,3,7,11],"new":[2,5],"public":6,"return":[3,7],"short":[0,7,11],"static":3,"true":[3,7],"while":9,about:2,accordingli:9,acknowledg:5,action:9,actual:[0,7,11],add:[2,10],against:[3,5,7,9],agre:9,all:[0,2,7,9,10,11],allow:3,along:3,alpha:9,alphanumer:7,also:9,alwai:2,ani:[3,7,9,10],any:2,anyth:[0,2,7,9,11],appear:[0,3,7,11],appreci:2,appropri:10,area:[0,5,7,9,11],argument:3,aris:9,articl:2,asciibetic:7,aside:7,associ:9,assum:9,assume:2,assur:5,author:9,automat:[5,9],avail:9,base:[0,3,7,9,10,11],been:9,befor:[2,7],best:2,better:9,bin:11,bit:2,blog:2,both:9,branch:2,broken:9,broken_linter_nam:3,bugfix:2,build:9,byfil:[0,7,11],bylint:[0,3,7,11],can:[2,6,7,9,11],cant_lint_filenam:3,captur:10,care:11,central:9,chang:[0,2,5,7,9,10,11],check:[0,2,7,9,11],checker:9,checkout:2,chmod:11,choos:7,cleanup_opt:3,clone:[2,6,9],cmake:9,cmd:3,code:[3,7,9],com:[1,2,6,9],combin:3,comma:[0,7,11],command:[5,6,7,9,10],commandlin:3,comment:7,commit:[0,2,4,5,7,9,10],complet:[7,9],complex:9,condit:[3,7],config:[0,3,7,10,11],configur:[0,3,7,9,10,11],confus:9,connect:9,consequenti:9,contract:9,copi:[2,6,9],correspond:10,could:2,coupl:10,creat:[2,3,9],criteria:10,curl:6,current:[0,3,5,7,9,10,11],custom:9,damag:9,data:9,deem:9,delta:10,descript:2,detail:[2,7],determin:10,dictionari:3,differ:[7,10],direct:9,directli:9,directori:[0,3,6,7,9,10,11],directroi:10,disclaim:5,doc:[2,9],docstr:2,don:[0,6,7,9,11],done:2,down:[0,7,9,10,11],download:[6,11],driven:2,dryrun:[0,3,7,11],each:[3,7,9,10],easier:2,edit:9,either:[6,9],elf:1,elfsternberg:[2,6,9],encode_shell_messag:3,ensur:9,entir:9,error:[3,7],even:[2,7],event:9,everi:[0,2,7,11],everyth:9,exampl:6,exclud:[0,7,11],executable_exist:3,exit:10,experiment:11,explain:2,extens:[3,7,9],extra:3,extract:3,fact:9,fail:[0,7,10,11],failur:[3,7,10],file:[0,2,3,5,6,7,9,10,11],filenam:[3,7,11],filter:[3,10],first:[0,1,7,11],fit:9,flake8:2,flip:7,follow:7,fork:2,free:9,from:[0,5],fullcmd:3,get_filelist:3,get_git_bas:3,get_git_head:3,get_git_respons:3,get_git_response_raw:3,get_linter_statu:3,get_shell_respons:3,git:[0,2,3,4],git_dir:[0,7,11],git_lint:2,github:[2,6,9,11],given:2,global:9,gmail:1,greatli:2,group:[0,7,11],grunt:9,guid:6,have:[0,2,3,6,7,9,11],hell:4,help:[0,2,3,7,11],here:2,highli:9,home:[6,9,10],hook:[5,9],how:[2,9],http:[2,6,9],ide:9,identifi:[5,9],impli:9,includ:[2,7,9],index:5,indirect:9,individu:9,inform:[0,7,11],ini:7,inspir:9,instal:[2,6,9],install:[2,5],installat:5,issu:2,just:[0,2,7,9,11],keep:[2,3],kenneth:1,label:3,let:7,letter:3,liabl:9,licens:9,life:9,like:9,line:[5,7,9,10],lint:[0,2,3,4],linter:[0,3,5,6,7,9,10,11],linter_nam:3,list:[0,2,3,7,10,11],littl:2,load:[3,10],load_config:3,local:2,look:2,loss:9,mai:[6,9],make:[2,9],make_match_filter_match:3,mani:2,master:6,match:[3,7,10],matchfilt:3,materi:9,maxim:7,meet:2,merchant:9,messag:[0,3,7,10,11],might:[2,9],minu:7,mit:9,mkvirtualenv:2,mode:10,more:[0,2,7,11],most:9,mostli:9,move:4,name:[2,3],narrow:2,need:9,neglig:9,none:1,noth:3,now:2,npm:9,object:3,offici:2,once:6,one:3,onli:[0,3,7,9,10,11],only:9,open:2,oper:2,order:7,org:2,origin:2,other:[2,9],otherwis:[3,9],ought:9,out:[4,9],output:3,overriden:9,own:9,page:5,param:3,part:2,pass:[0,2,7,10,11],path:[0,7,11],per:[3,9],perform:[3,9],person:9,phase:10,pip:[2,6,9],plan:9,pleas:[2,6,11],possibl:[2,9],post:2,pre:[0,4,5,7,9,10],prefix:[3,7],print:[0,7,10,11],print_help:3,print_lint:3,print_report:3,print_vers:3,process:[3,6],produc:[0,7,11],profit:9,program:[5,9],project:[2,3,9,11],propos:2,provid:[5,9],prune:10,pulec:9,pull_request:2,push:2,put:2,pypi:2,python:[2,6,9],qualiti:[5,9],quiet:[0,7,11],readi:2,readme:[2,5],reason:9,receiv:3,recent:9,record:10,reduc:10,releas:5,rememb:2,replac:3,repo:[2,6,9],repodir:3,report:0,repositori:[3,5,6,7,9,10,11],reproduc:2,requir:9,restor:[9,10],result:[3,7,9,10],risk:9,rst:2,run:[0,2,3,5,6,7,9,10,11],run_external_lint:3,run_git_command:3,run_lint:3,run_one_lint:3,safeconfigpars:3,same:9,scan:[0,7,11],scope:2,script:3,search:5,second:[0,7,11],section:7,send:2,separ:[0,7,11],set:[2,3,7,9],setup:[2,6,9],shall:9,shell:9,should:2,show:[0,7,10,11],simpl:9,sinc:9,skip:[0,7,11],slightli:[0,7,11],softwar:9,some:9,sort:7,sourc:[3,5],special:9,specif:3,specifi:[3,7],split_git_respons:3,sponsor:9,stabl:5,stage:[0,5,7,9,10,11],stagingrunn:3,standard:7,stash:[9,10],statu:[7,10],step:2,sternberg:1,steve:9,still:9,string:3,style:[5,7,9],subset:2,substitut:3,succe:7,success:3,supersed:3,support:2,sure:2,syntax:[5,9],system:[2,9],tabl:3,tag:2,take:3,tarbal:6,termin:6,test:2,test_git_lint:2,text:[3,7],thei:[0,2,7,11],them:2,thi:[2,3,6,7,9,10],those:[0,3,7,11],through:[2,6],time:9,timestamp:[9,10],token:7,tortiou:9,touch:10,tox:2,travi:2,troubleshoot:2,tupl:3,understand:9,understood:9,unfindable_filenam:3,unlintable_filenam:3,unstag:10,updat:2,upon:9,usage:5,used:9,user:[3,9,10],vcs:9,verbos:[0,7,11],vers:7,version:[0,2,3,4,7,11],virtualenv:2,virtualenvwrapp:2,volunt:2,wai:[2,9],want:[2,9],warranti:9,web:2,websit:2,welcom:2,well:9,were:9,what:[0,7,9,10,11],whatev:9,whatsoev:9,when:[2,7,9],whether:[2,9],which:[3,7,10],whoever:2,why:[1,9],without:9,work:[2,7,9],workspac:[0,7,9,10,11],workspacerunn:3,would:[0,2,7,11],wrapper:9,wrong:9,yet:1,you:[2,6,7,9,11],your:[2,5,6,7,9],your_name_her:2,zero:7},titles:["<no title>","Credits","Contributing","git_lint package","History","Git Lint","Installation","git-lint(1)","git_lint","Git Lint: README","Strategies","Usage"],titleterms:{acknowledg:9,bug:2,command:11,commit:11,configuration:7,content:[3,11],contribut:2,contributor:1,credit:1,description:7,develop:1,disclaim:9,document:[2,9],featur:[2,9],feedback:2,fix:2,from:6,get:2,git:[5,7,9],git_lint:[3,8],guidelin:2,histori:4,hook:11,implement:2,indice:5,install:9,installat:6,lead:1,line:11,lint:[5,7,9],modul:3,name:7,option:[3,11],option_handl:3,options:7,output:7,packag:3,pre:11,pull:2,readme:9,releas:6,report:[2,3],request:2,sourc:6,stabl:6,start:2,strategi:10,submit:2,submodul:3,synopsis:7,tabl:5,tip:2,type:2,usage:[9,11],write:2}})
\ No newline at end of file