upstream/mercurial-mirror Files · contrib/python-hook-examples.py

configitems: declare items in a TOML file...

configitems: declare items in a TOML file Mercurial ships with Rust code that also needs to read from the config. Having a way of presenting `configitems` to both Python and Rust is needed to prevent duplication, drift, and have the appropriate devel warnings. Abstracting away from Python means choosing a config format. No single format is perfect, and I have yet to come across a developer that doesn't hate all of them in some way. Since we have a strict no-dependencies policy for Mercurial, we either need to use whatever comes with Python, vendor a library, or implement a custom format ourselves. Python stdlib means using JSON, which doesn't support comments and isn't great for humans, or `configparser` which is an obscure, untyped format that nobody uses and doesn't have a commonplace Rust parser. Implementing a custom format is error-prone, tedious and subject to the same issues as picking an existing format. Vendoring opens us to the vast array of common config formats. The ones being picked for most modern software are YAML and TOML. YAML is older and common in the Python community, but TOML is much simpler and less error-prone. I would much rather be responsible for the <1000 lines of `tomli`, on top of TOML being the choice of the Rust community, with robust crates for reading it. The structure of `configitems.toml` is explained inline.

Gregory Szorc - - Load All Authors

File last commit:

r49730:6000f5b2 default


                r51655:c51b178b

default

Download file

             python-hook-examples.py
        
                    26 lines
            
             | 594 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / contrib / python-hook-examples.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Alexander Solovyov
    
diffstat hook example

              r7917
            
      '''

        Benoit Boissinot
    
Change wording in example hook

              r7918
            
      Examples of useful python hooks for Mercurial.

        Alexander Solovyov
    
diffstat hook example

              r7917
            
      '''

        Pulkit Goyal
    
contrib: python-hook-examples use absolute_import

              r28562
            
      from mercurial import (

          patch,

          util,

      )

        Alexander Solovyov
    
diffstat hook example

              r7917
            
        Augie Fackler
    
formatting: blacken the codebase...

              r43346
            
        Alexander Solovyov
    
diffstat hook example

              r7917
            
      def diffstat(ui, repo, **kwargs):

        Augie Fackler
    
formating: upgrade to black 20.8b1...

              r46554
            
          """Example usage:

        Alexander Solovyov
    
diffstat hook example

              r7917
            
          [hooks]

          commit.diffstat = python:/path/to/this/file.py:diffstat

          changegroup.diffstat = python:/path/to/this/file.py:diffstat

        Augie Fackler
    
formating: upgrade to black 20.8b1...

              r46554
            
          """

        Alexander Solovyov
    
diffstat hook example

              r7917
            
          if kwargs.get('parent2'):

              return

          node = kwargs['node']

        Matt Mackall
    
misc: replace .parents()[0] with p1()

              r13878
            
          first = repo[node].p1().node()

        Alexander Solovyov
    
diffstat hook example

              r7917
            
          if 'url' in kwargs:

        Martin von Zweigbergk
    
repo: don't look up context for tip node if it's not needed...

              r39931
            
              last = repo.changelog.tip()

        Alexander Solovyov
    
diffstat hook example

              r7917
            
          else:

              last = node

          diff = patch.diff(repo, first, last)

          ui.write(patch.diffstat(util.iterlines(diff)))

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Alexander Solovyov diffstat hook example	r7917	'''
Benoit Boissinot Change wording in example hook	r7918	Examples of useful python hooks for Mercurial.
Alexander Solovyov diffstat hook example	r7917	'''
Pulkit Goyal contrib: python-hook-examples use absolute_import	r28562	from mercurial import (
		patch,
		util,
		)
Alexander Solovyov diffstat hook example	r7917
Augie Fackler formatting: blacken the codebase...	r43346
Alexander Solovyov diffstat hook example	r7917	def diffstat(ui, repo, **kwargs):
Augie Fackler formating: upgrade to black 20.8b1...	r46554	"""Example usage:
Alexander Solovyov diffstat hook example	r7917
		[hooks]
		commit.diffstat = python:/path/to/this/file.py:diffstat
		changegroup.diffstat = python:/path/to/this/file.py:diffstat
Augie Fackler formating: upgrade to black 20.8b1...	r46554	"""
Alexander Solovyov diffstat hook example	r7917	if kwargs.get('parent2'):
		return
		node = kwargs['node']
Matt Mackall misc: replace .parents()[0] with p1()	r13878	first = repo[node].p1().node()
Alexander Solovyov diffstat hook example	r7917	if 'url' in kwargs:
Martin von Zweigbergk repo: don't look up context for tip node if it's not needed...	r39931	last = repo.changelog.tip()
Alexander Solovyov diffstat hook example	r7917	else:
		last = node
		diff = patch.diff(repo, first, last)
		ui.write(patch.diffstat(util.iterlines(diff)))