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

tracked-key: remove the dual write and rename to tracked-hint...

tracked-key: remove the dual write and rename to tracked-hint The dual-write approach was mostly useless. As explained in the previous version of the help, the key had to be read twice before we could cache a value. However this "read twice" limitation actually also apply to any usage of the key. If some operation wants to rely of the "same value == same tracked set" property it would need to read the value before, and after running that operation (or at least, after, in all cases). So it cannot be sure the operation it did is "valid" until checking the key after the operation. As a resultat such operation can only be read-only or rollbackable. This reduce the utility of the "same value == same tracked set" a lot. So it seems simpler to drop the double write and to update the documentation to highlight that this file does not garantee race-free operation. As a result the "key" is demoted to a "hint". Documentation is updated accordingly. Differential Revision: https://phab.mercurial-scm.org/D12201

Augie Fackler - - Load All Authors

File last commit:

r43346:2372284d default


                r49644:6e559391

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)