tools/patman/commit.py

   1 # SPDX-License-Identifier: GPL-2.0+
   2 # Copyright (c) 2011 The Chromium OS Authors.
   3 #
   4
   5 import collections
   6 import re
   7
   8 # Separates a tag: at the beginning of the subject from the rest of it
   9 re_subject_tag = re.compile('([^:\s]*):\s*(.*)')
  10
  11 class Commit:
  12     """Holds information about a single commit/patch in the series.
  13
  14     Args:
  15         hash: Commit hash (as a string)
  16
  17     Variables:
  18         hash: Commit hash
  19         subject: Subject line
  20         tags: List of maintainer tag strings
  21         changes: Dict containing a list of changes (single line strings).
  22             The dict is indexed by change version (an integer)
  23         cc_list: List of people to aliases/emails to cc on this commit
  24         notes: List of lines in the commit (not series) notes
  25         change_id: the Change-Id: tag that was stripped from this commit
  26             and can be used to generate the Message-Id.
  27         rtags: Response tags (e.g. Reviewed-by) collected by the commit, dict:
  28             key: rtag type (e.g. 'Reviewed-by')
  29             value: Set of people who gave that rtag, each a name/email string
  30     """
  31     def __init__(self, hash):
  32         self.hash = hash
  33         self.subject = None
  34         self.tags = []
  35         self.changes = {}
  36         self.cc_list = []
  37         self.signoff_set = set()
  38         self.notes = []
  39         self.change_id = None
  40         self.rtags = collections.defaultdict(set)
  41
  42     def AddChange(self, version, info):
  43         """Add a new change line to the change list for a version.
  44
  45         Args:
  46             version: Patch set version (integer: 1, 2, 3)
  47             info: Description of change in this version
  48         """
  49         if not self.changes.get(version):
  50             self.changes[version] = []
  51         self.changes[version].append(info)
  52
  53     def CheckTags(self):
  54         """Create a list of subject tags in the commit
  55
  56         Subject tags look like this:
  57
  58             propounder: fort: Change the widget to propound correctly
  59
  60         Here the tags are propounder and fort. Multiple tags are supported.
  61         The list is updated in self.tag.
  62
  63         Returns:
  64             None if ok, else the name of a tag with no email alias
  65         """
  66         str = self.subject
  67         m = True
  68         while m:
  69             m = re_subject_tag.match(str)
  70             if m:
  71                 tag = m.group(1)
  72                 self.tags.append(tag)
  73                 str = m.group(2)
  74         return None
  75
  76     def AddCc(self, cc_list):
  77         """Add a list of people to Cc when we send this patch.
  78
  79         Args:
  80             cc_list:    List of aliases or email addresses
  81         """
  82         self.cc_list += cc_list
  83
  84     def CheckDuplicateSignoff(self, signoff):
  85         """Check a list of signoffs we have send for this patch
  86
  87         Args:
  88             signoff:    Signoff line
  89         Returns:
  90             True if this signoff is new, False if we have already seen it.
  91         """
  92         if signoff in self.signoff_set:
  93           return False
  94         self.signoff_set.add(signoff)
  95         return True
  96
  97     def AddRtag(self, rtag_type, who):
  98         """Add a response tag to a commit
  99
 100         Args:
 101             key: rtag type (e.g. 'Reviewed-by')
 102             who: Person who gave that rtag, e.g. 'Fred Bloggs <fred@bloggs.org>'
 103         """
 104         self.rtags[rtag_type].add(who)