upstream/mercurial-mirror Files · contrib/debugcmdserver.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

             debugcmdserver.py
        
                    50 lines
            
             | 1.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / contrib / debugcmdserver.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #!/usr/bin/env python3

      #

      # Dumps output generated by Mercurial's command server in a formatted style to a

      # given file or stderr if '-' is specified. Output is also written in its raw

      # format to stdout.

      #

      # $ ./hg serve --cmds pipe | ./contrib/debugcmdserver.py -

      # o, 52   -> 'capabilities: getencoding runcommand\nencoding: UTF-8'

      import struct

      import sys

      if len(sys.argv) != 2:

          print('usage: debugcmdserver.py FILE')

          sys.exit(1)

      outputfmt = '>cI'

      outputfmtsize = struct.calcsize(outputfmt)

      if sys.argv[1] == '-':

          log = sys.stderr

      else:

          log = open(sys.argv[1], 'a')

      def read(size):

          data = sys.stdin.read(size)

          if not data:

              raise EOFError

          sys.stdout.write(data)

          sys.stdout.flush()

          return data

      try:

          while True:

              header = read(outputfmtsize)

              channel, length = struct.unpack(outputfmt, header)

              log.write('%s, %-4d' % (channel, length))

              if channel in 'IL':

                  log.write(' -> waiting for input\n')

              else:

                  data = read(length)

                  log.write(' -> %r\n' % data)

              log.flush()

      except EOFError:

          pass

      finally:

          if log != sys.stderr:

              log.close()

	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

				#!/usr/bin/env python3
				#
				# Dumps output generated by Mercurial's command server in a formatted style to a
				# given file or stderr if '-' is specified. Output is also written in its raw
				# format to stdout.
				#
				# $ ./hg serve --cmds pipe \| ./contrib/debugcmdserver.py -
				# o, 52 -> 'capabilities: getencoding runcommand\nencoding: UTF-8'

				import struct
				import sys

				if len(sys.argv) != 2:
				print('usage: debugcmdserver.py FILE')
				sys.exit(1)

				outputfmt = '>cI'
				outputfmtsize = struct.calcsize(outputfmt)

				if sys.argv[1] == '-':
				log = sys.stderr
				else:
				log = open(sys.argv[1], 'a')


				def read(size):
				data = sys.stdin.read(size)
				if not data:
				raise EOFError
				sys.stdout.write(data)
				sys.stdout.flush()
				return data


				try:
				while True:
				header = read(outputfmtsize)
				channel, length = struct.unpack(outputfmt, header)
				log.write('%s, %-4d' % (channel, length))
				if channel in 'IL':
				log.write(' -> waiting for input\n')
				else:
				data = read(length)
				log.write(' -> %r\n' % data)
				log.flush()
				except EOFError:
				pass
				finally:
				if log != sys.stderr:
				log.close()