Bates Numbering customization

Adds three new params to the `bates_number` function: two offsets and font_size.

* `offset_horizontal` is the distance from the left or right edge to the numbers, in PDF space units (default of 1/72th inch)
* `offset_vertical` is the distance from the top or bottom edge to the numbers, in PDF space units (default of 1/72th inch)
* `font_size` is the size of the numbers in points

Author: BryceStevenWilley

docassemble_base/docassemble/base/bates.py

@@ -7,14 +7,17 @@
 parser.add_argument("--digits", help="number of digits in Bates numbers", type=int)
 parser.add_argument("--start", help="starting number", type=int)
 parser.add_argument("--area", help="area of page")
+parser.add_argument("--offset-horizontal", help="how far to offset the number from the side of the page", type=float)
+parser.add_argument("--offset-vertical", help="how far to offset the number from the side of the page", type=float)
+parser.add_argument("--font-size", help="How big the numbers are", type=float)
 
 
-def bates_number(docs, prefix, digits, start_number, area):
-    m = Marisol(prefix, digits, start_number, area=getattr(Area, area))
+def bates_number(docs, prefix, digits, start_number, area, offset_horizontal, offset_vertical, font_size):
+    m = Marisol(prefix, digits, start_number, area=getattr(Area, area), offset_horizontal=offset_horizontal, offset_vertical=offset_vertical, font_size=font_size)
     for doc in docs:
         m.append(doc)
     m.save()
 
 if __name__ == "__main__":
     args = parser.parse_args()
-    bates_number(args.files, args.prefix, args.digits, args.start, args.area)
+    bates_number(args.files, args.prefix, args.digits, args.start, args.area, args.offset_horizontal, args.offset_vertical, args.font_size)

docassemble_base/docassemble/base/marisol/marisol.py

@@ -27,7 +27,7 @@ def __init__(self, stroke, fill, text):
 
 class Marisol:
 
-    def __init__(self, prefix, fill, start, area=Area.BOTTOM_RIGHT):
+    def __init__(self, prefix, fill, start, area=Area.BOTTOM_RIGHT, offset_horizontal=None, offset_vertical=None, font_size=None):
         """
         Marisol Base Class - A collection of documents to be bates numbered.
 
@@ -36,6 +36,9 @@ def __init__(self, prefix, fill, start, area=Area.BOTTOM_RIGHT):
             fill (int): Length for zero-filling
             start (int): Starting bates number
             area (Area): Area in which to place the bates number.
+            offset_horizontal: distance from the left or right edge to place the bates number
+            offset_vertical: distance from the top or bottom edge to place the bates number
+            font_size: the size of the font for the bates number
         """
         self.prefix = prefix
         self.fill = fill
@@ -46,6 +49,9 @@ def __init__(self, prefix, fill, start, area=Area.BOTTOM_RIGHT):
         self.number = 0
 
         self.documents = []
+        self.offset_horizontal = offset_horizontal
+        self.offset_vertical = offset_vertical
+        self.font_size = font_size
         self.overwrite = False
 
     def __getitem__(self, key):
@@ -90,7 +96,7 @@ def append(self, file):
         Returns:
             marisol.Marisol: The current Marisol instance.
         """
-        d = Document(file, self.prefix, self.fill, self.start+self.number, self.area)
+        d = Document(file, self.prefix, self.fill, self.start+self.number, self.area, self.offset_horizontal, self.offset_vertical, self.font_size)
         self.number += len(d)
         self.documents.append(d)
         return self
@@ -114,7 +120,7 @@ def save(self, overwrite=False, threads=multiprocessing.cpu_count()*6):
 
 class Document:
 
-    def __init__(self, file, prefix, fill, start, area):
+    def __init__(self, file, prefix, fill, start, area, offset_horizontal=None, offset_vertical=None, font_size=None):
         """
         Represents a document to be numbered.
 
@@ -124,6 +130,9 @@ def __init__(self, file, prefix, fill, start, area):
             fill (int): Length to zero-pad number to.
             start (int): Number to start with.
             area (Area): Area on the document where the number should be drawn
+            offset_horizontal: distance from the left or right edge to place the bates number
+            offset_vertical: distance from the top or bottom edge to place the bates number
+            font_size: the size of the font for the bates number
         """
         self.reader = Pdf.open(file)
         self.prefix = prefix
@@ -132,13 +141,13 @@ def __init__(self, file, prefix, fill, start, area):
         self.area = area
 
         self.overlays = {x: None for x in Area}
-        self.overlays[area] = BatesOverlay(None, self.area)
+        self.overlays[area] = BatesOverlay(None, self.area, offset_horizontal, offset_vertical)
 
         self.index = 0
 
         self.pages = []
         for num, page in enumerate(self.reader.pages):
-            p = Page(self, page, self.prefix, self.fill, self.start + num)
+            p = Page(self, page, self.prefix, self.fill, self.start + num, font_size)
             self.pages.append(p)
 
     def __getitem__(self, k):
@@ -226,7 +235,7 @@ def add_overlay(self, overlay):
 
 class Page:
 
-    def __init__(self, document, page, prefix, fill, start):
+    def __init__(self, document, page, prefix, fill, start, font_size=None):
         """
         Represents a page within a document that will be bates numbered.
 
@@ -236,6 +245,7 @@ def __init__(self, document, page, prefix, fill, start):
             prefix (str): Bates number prefix.
             fill (int): Length to zero-pad number to.
             start (int): Number to start with.
+            font_size: the size of the font for the bates number
         """
         self.document = document
         self.page = page
@@ -248,6 +258,7 @@ def __init__(self, document, page, prefix, fill, start):
 
         self.canvas_file = io.BytesIO()
         self.canvas = canvas.Canvas(self.canvas_file, pagesize=(self.width, self.height))
+        self.canvas.setFontSize(font_size)
 
         self.redactions = []
 
@@ -310,9 +321,11 @@ def number(self):
 
 class GenericTextOverlay:
 
-    def __init__(self, text, area):
+    def __init__(self, text, area, offset_horizontal=15, offset_vertical=15):
         self.text = text
         self.area = area
+        self.offset_horizontal = offset_horizontal
+        self.offset_vertical = offset_vertical
 
     def apply(self, c):
         """
@@ -335,14 +348,14 @@ def position(self, c):
             tuple: the position
         """
         if self.area in [Area.TOP_LEFT, Area.TOP_RIGHT]:  # top
-            from_bottom = c._pagesize[1]-15  # 15 down from height of page
+            from_bottom = c._pagesize[1] - self.offset_vertical # down from height of page
         elif self.area in [Area.BOTTOM_LEFT, Area.BOTTOM_RIGHT]:  # bottom
-            from_bottom = 15  # 15 up from bottom of page
+            from_bottom = self.offset_vertical  # up from bottom of page
 
         if self.area in [Area.TOP_LEFT, Area.BOTTOM_LEFT]:  # left
-            from_left = 15
+            from_left = self.offset_horizontal
         elif self.area in [Area.TOP_RIGHT, Area.BOTTOM_RIGHT]:  # right
-            offset = 15  # initial offset
+            offset = self.offset_horizontal  # initial offset
             offset += c.stringWidth(self.text)  # offset for text length
             from_left = c._pagesize[0]-offset
 

docassemble_base/docassemble/base/util.py

@@ -5289,13 +5289,16 @@ def bates_number(self, *pargs, **kwargs):
         digits = kwargs.get('digits', 5)
         start = kwargs.get('start', 1)
         area = kwargs.get('area', None)
+        font_size = kwargs.get('font_size', 10)
+        offset_horizontal = kwargs.get('offset_horizontal', 15)
+        offset_vertical = kwargs.get('offset_vertical', 15)
         if area is None:
             area = 'BOTTOM_RIGHT'
         if area not in ('TOP_LEFT', 'TOP_RIGHT', 'BOTTOM_RIGHT', 'BOTTOM_LEFT'):
             raise DAError("bates_number: area must be one of TOP_LEFT, TOP_RIGHT, BOTTOM_RIGHT, or BOTTOM_LEFT")
         if filename is None:
             filename = 'file.pdf'
-        args = [os.path.join(server.daconfig['modules'], 'bin', 'python'), '-m', 'docassemble.base.bates', '--prefix', str(prefix), '--digits', str(digits), '--start', str(start), '--area', area]
+        args = [os.path.join(server.daconfig['modules'], 'bin', 'python'), '-m', 'docassemble.base.bates', '--prefix', str(prefix), '--digits', str(digits), '--start', str(start), '--area', area, '--font-size', str(font_size), '--offset-horizontal', str(offset_horizontal), '--offset-vertical', str(offset_vertical)]
         for doc in docs:
             if isinstance(doc, str):
                 args.append(doc)