upstream/mercurial-mirror Files · contrib/automation/hgautomation/__init__.py

pycompat: use os.fsencode() to re-encode sys.argv...

pycompat: use os.fsencode() to re-encode sys.argv Historically, the previous code made sense, as Py_EncodeLocale() and fs.fsencode() could possibly use different encodings. However, this is not the case anymore for Python 3.2, which uses the locale encoding as the filesystem encoding (this is not true for later Python versions, but see below). See https://vstinner.github.io/painful-history-python-filesystem-encoding.html for a source and more background information. Using os.fsencode() is safer, as the documentation for sys.argv says that it can be used to get the original bytes. When doing further changes, the Python developers will take care that this continues to work. One concrete case where os.fsencode() is more correct is when enabling Python's UTF-8 mode. Py_DecodeLocale() will use UTF-8 in this case. Our previous code would have encoded it using the locale encoding (which might be different), whereas os.fsencode() will encode it with UTF-8. Since we don’t claim to support the UTF-8 mode, this is not really a bug and the patch can go to the default branch. It might be a good idea to not commit this to the stable branch, as it could in theory introduce regressions.

Augie Fackler - - Load All Authors

File last commit:

r43346:2372284d default


                r45533:f2de8f31

default

Download file

             __init__.py
        
                    57 lines
            
             | 1.5 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / contrib / automation / hgautomation / __init__.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # __init__.py - High-level automation interfaces

      #

      # Copyright 2019 Gregory Szorc <gregory.szorc@gmail.com>

      #

      # This software may be used and distributed according to the terms of the

      # GNU General Public License version 2 or any later version.

      # no-check-code because Python 3 native.

      import pathlib

      import secrets

      from .aws import AWSConnection

      class HGAutomation:

          """High-level interface for Mercurial automation.

          Holds global state, provides access to other primitives, etc.

          """

          def __init__(self, state_path: pathlib.Path):

              self.state_path = state_path

              state_path.mkdir(exist_ok=True)

          def default_password(self):

              """Obtain the default password to use for remote machines.

              A new password will be generated if one is not stored.

              """

              p = self.state_path / 'default-password'

              try:

                  with p.open('r', encoding='ascii') as fh:

                      data = fh.read().strip()

                      if data:

                          return data

              except FileNotFoundError:

                  pass

              password = secrets.token_urlsafe(24)

              with p.open('w', encoding='ascii') as fh:

                  fh.write(password)

                  fh.write('\n')

              p.chmod(0o0600)

              return password

          def aws_connection(self, region: str, ensure_ec2_state: bool = True):

              """Obtain an AWSConnection instance bound to a specific region."""

              return AWSConnection(self, region, ensure_ec2_state=ensure_ec2_state)

	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

				# __init__.py - High-level automation interfaces
				#
				# Copyright 2019 Gregory Szorc <gregory.szorc@gmail.com>
				#
				# This software may be used and distributed according to the terms of the
				# GNU General Public License version 2 or any later version.

				# no-check-code because Python 3 native.

				import pathlib
				import secrets

				from .aws import AWSConnection


				class HGAutomation:
				"""High-level interface for Mercurial automation.

				Holds global state, provides access to other primitives, etc.
				"""

				def __init__(self, state_path: pathlib.Path):
				self.state_path = state_path

				state_path.mkdir(exist_ok=True)

				def default_password(self):
				"""Obtain the default password to use for remote machines.

				A new password will be generated if one is not stored.
				"""
				p = self.state_path / 'default-password'

				try:
				with p.open('r', encoding='ascii') as fh:
				data = fh.read().strip()

				if data:
				return data

				except FileNotFoundError:
				pass

				password = secrets.token_urlsafe(24)

				with p.open('w', encoding='ascii') as fh:
				fh.write(password)
				fh.write('\n')

				p.chmod(0o0600)

				return password

				def aws_connection(self, region: str, ensure_ec2_state: bool = True):
				"""Obtain an AWSConnection instance bound to a specific region."""

				return AWSConnection(self, region, ensure_ec2_state=ensure_ec2_state)