finalcif 177__tar.gz → 178__tar.gz

finalcif-178/LICENSE.md

@@ -0,0 +1,5 @@
+"THE BEER-WARE LICENSE" (Revision 42):
+Daniel Kratzert, dkratzert@gmx.de wrote this file.  As long as you retain
+this notice you can do whatever you want with this stuff. If we meet some day,
+and you think this stuff is worth it, you can buy me a beer in return.
+Dr. Daniel Kratzert

{finalcif-177 → finalcif-178}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.5
 Name: finalcif
-Version: 177
+Version: 178
 Summary: CIF file editor
 Project-URL: Homepage, https://dkratzert.de/finalcif.html
 Project-URL: Bug Tracker, https://github.com/dkratzert/FinalCif/issues
 Author-email: Daniel Kratzert <dkratzert@gmx.de>
-License-File: LICENSE
+License-Expression: Beerware
+License-File: LICENSE.md
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering :: Chemistry
@@ -33,16 +33,13 @@ Requires-Dist: qtpy
 Requires-Dist: requests
 Requires-Dist: shelxfile>=24
 Requires-Dist: urllib3==2.7.0
-Requires-Dist: wheel==0.47.0
 Description-Content-Type: text/markdown
 
 ![Latest Release](https://img.shields.io/github/v/tag/dkratzert/FinalCif?label=Release)
 [![Unit Tests](https://github.com/dkratzert/FinalCif/actions/workflows/python_tests.yml/badge.svg?branch=master)](https://github.com/dkratzert/FinalCif/actions/workflows/python_tests.yml)
 ![Contributions](https://img.shields.io/badge/contributions-welcome-blue)
-[![PyPI package](https://repology.org/badge/version-for-repo/pypi/python:finalcif.svg)](https://repology.org/project/python:finalcif/versions)
-<a href="https://repology.org/project/finalcif/versions">
-    <img src="https://repology.org/badge/vertical-allrepos/finalcif.svg" alt="Packaging status" align="right">
-</a>
+[![PyPI version](https://img.shields.io/pypi/v/finalcif.svg)](https://pypi.org/project/finalcif/)
+
 
 
 # FinalCif

{finalcif-177 → finalcif-178}/README.md

@@ -1,10 +1,8 @@
 ![Latest Release](https://img.shields.io/github/v/tag/dkratzert/FinalCif?label=Release)
 [![Unit Tests](https://github.com/dkratzert/FinalCif/actions/workflows/python_tests.yml/badge.svg?branch=master)](https://github.com/dkratzert/FinalCif/actions/workflows/python_tests.yml)
 ![Contributions](https://img.shields.io/badge/contributions-welcome-blue)
-[![PyPI package](https://repology.org/badge/version-for-repo/pypi/python:finalcif.svg)](https://repology.org/project/python:finalcif/versions)
-<a href="https://repology.org/project/finalcif/versions">
-    <img src="https://repology.org/badge/vertical-allrepos/finalcif.svg" alt="Packaging status" align="right">
-</a>
+[![PyPI version](https://img.shields.io/pypi/v/finalcif.svg)](https://pypi.org/project/finalcif/)
+
 
 
 # FinalCif

finalcif-178/finalcif/__init__.py

@@ -0,0 +1,3 @@
+
+VERSION = 178
+__version__ = VERSION

{finalcif-177 → finalcif-178}/finalcif/appwindow.py

@@ -21,7 +21,6 @@ from math import sin, radians
 from pathlib import Path, WindowsPath
 from typing import cast, TYPE_CHECKING
 
-
 if TYPE_CHECKING:
     from finalcif.cif.checkcif.checkcif import MyHTMLParser
 
@@ -1625,7 +1624,6 @@ class AppWindow(QMainWindow):
         """
         Generates a report document.
         """
-        from finalcif.report.tables import make_multi_tables
         from finalcif.report.templated_report import ReportFormat, TemplatedReport
         from docx.image.exceptions import UnrecognizedImageError
         current_block = self.ui.datanameComboBox.currentIndex()
@@ -1638,7 +1636,7 @@ class AppWindow(QMainWindow):
             return None
         self.load_cif_file(self.cif.finalcif_file, block=current_block, load_changes=False)
         report_filename = self.cif.finalcif_file_prefixed(prefix='report_', suffix='-finalcif.docx')
-        multi_table_document = self.cif.finalcif_file_prefixed(prefix='', suffix='-multitable.docx')
+        multi_table_document: Path | None = None
         self.cif.picometer = self.options.use_picometers
         # The picture after the header:
         if self.report_picture_path:
@@ -1652,9 +1650,12 @@ class AppWindow(QMainWindow):
             if template_path.suffix in ('.docx',):
                 t = TemplatedReport(format=ReportFormat.RICHTEXT, options=self.options, cif=self.cif)
                 ok = t.make_templated_docx_report(output_filename=str(report_filename),
-                                                  template_path=Path(self.get_checked_templates_list_text()))
-                if self.cif.is_multi_cif and self.cif.doc[0].name != 'global':
-                    make_multi_tables(cif=self.cif, output_filename=str(multi_table_document))
+                                                  template_path=template_path)
+                if (ok and self.cif.is_multi_cif and self.cif.doc[0].name != 'global'
+                        and not t.is_multi_cif_template):
+                    multi_table_document = self.cif.finalcif_file_prefixed(prefix='', suffix='-multitable.docx')
+                    ok = t.make_templated_docx_report(output_filename=str(multi_table_document),
+                                                      template_path=application_path / 'template' / 'template_for_multitable.docx')
             elif template_path.suffix in ('.html', '.tmpl'):
                 t = TemplatedReport(format=ReportFormat.HTML, options=self.options, cif=self.cif)
                 report_filename = report_filename.with_suffix('.html')
@@ -1687,16 +1688,16 @@ class AppWindow(QMainWindow):
             if DEBUG:
                 print('dbg> Unrecognized image error')
                 raise
-            show_general_warning(self,'The report contains an unrecognized image format.')
+            show_general_warning(self, 'The report contains an unrecognized image format.')
             return None
         if not self.running_inside_unit_test:
             self.open_report_document(report_filename, multi_table_document)
             # Save report and other files to a zip file:
-            self.zip_report(report_filename)
+            self.zip_report(report_filename, multi_table_document)
             return None
         return None
 
-    def zip_report(self, report_filename: Path) -> None:
+    def zip_report(self, report_filename: Path, multi_table_document: Path | None = None) -> None:
         from finalcif.report.archive_report import ArchiveReport
         zipfile = self.cif.finalcif_file.with_suffix('.zip')
         if zipfile.exists():
@@ -1711,16 +1712,16 @@ class AppWindow(QMainWindow):
         with suppress(Exception):
             pdfname = self.cif.finalcif_file_prefixed(prefix='checkcif-', suffix='-finalcif.pdf')
             arc.zip.write(filename=pdfname, arcname=pdfname.name)
-        with suppress(Exception):
-            multitable = self.cif.finalcif_file_prefixed(prefix='', suffix='-multitable.docx')
-            arc.zip.write(filename=multitable, arcname=multitable.name)
+        if multi_table_document is not None:
+            with suppress(Exception):
+                arc.zip.write(filename=multi_table_document, arcname=multi_table_document.name)
         with suppress(Exception):
             prp_list = self.cif.finalcif_file.parent.glob('*.prp')
             sorted_prp = sorted(prp_list, key=lambda x: x.stat().st_mtime)
             arc.zip.write(filename=sorted_prp[-1], arcname=sorted_prp[-1].name)
 
-    def open_report_document(self, report_filename: Path, multi_table_document: Path) -> None:
-        if self.cif.is_multi_cif:
+    def open_report_document(self, report_filename: Path, multi_table_document: Path | None = None) -> None:
+        if multi_table_document is not None:
             open_file(multi_table_document)
         open_file(report_filename)
 
@@ -2295,16 +2296,18 @@ class AppWindow(QMainWindow):
             d = 0.0
         self.ui.numRestraintsLineEdit.setText(self.cif['_refine_ls_number_restraints'])
         self.ui.thetaMaxLineEdit.setText(thetamax)
-        self.ui.thetaFullLineEdit.setText(self.cif['_diffrn_reflns_theta_full'])
+        theta_full = self.cif['_diffrn_reflns_theta_full']
+        self.ui.thetaFullLineEdit.setText(theta_full)
         self.ui.dLineEdit.setText(f"{d:5.3f}")
         try:
-            compl = float(self.cif['_diffrn_measured_fraction_theta_max']) * 100
+            fraction = self.cif['_diffrn_measured_fraction_theta_full']
+            compl = float(fraction) * 100
             if not compl:
                 compl = 0.0
         except (TypeError, ValueError):
             compl = 0.0
         try:
-            self.ui.completeLineEdit.setText(f"{compl:<5.1f}")
+            self.ui.completeLineEdit.setText(f"{compl:<5.1f} (at {theta_full}°)")
         except ValueError:
             pass
         self.ui.wavelengthLineEdit.setText(f"{wavelen}")

{finalcif-177 → finalcif-178}/finalcif/report/references.py

@@ -5,10 +5,6 @@
 #  and you think this stuff is worth it, you can buy me a beer in return.
 #  Dr. Daniel Kratzert
 #  ----------------------------------------------------------------------------
-from contextlib import suppress
-from typing import Union
-
-from docx.text.paragraph import Paragraph
 from docxtpl import RichText
 
 from finalcif import VERSION
@@ -43,89 +39,6 @@ Missing: d*trek
 """
 
 
-class ReferenceList:
-    """
-    This reference list holds a list of all used references. During each self.append(Reference()), a new reference is
-    appended to the list. 
-    At the end of the document, a numbered list of references can be generated with self.make_make_literature_list().
-    """
-
-    def __init__(self, paragraph: Paragraph):
-        self.paragraph = paragraph
-        self._references = []
-
-    def append(self, ref: Union[list['Reference'], tuple['Reference'], 'Reference']) -> None:
-        """Adds a superscript list of reference numbers in brackets to the document."""
-        if isinstance(ref, list | tuple):
-            if not ref:
-                return None
-            self._append_list(ref)
-        else:
-            if ref not in self._references:
-                self._references.append(ref)
-            self.paragraph.add_run(f'[{self._references.index(ref) + 1}]').font.superscript = True
-        # better not here:
-        # self.paragraph.add_run(' ')
-
-    def _append_list(self, reflist: list) -> None:
-        reflst_long = []
-        self.paragraph.add_run('[').font.superscript = True
-        reflist = [x for x in reflist if x]
-        for n, ref in enumerate(reflist):
-            if ref not in self._references:
-                self._references.append(ref)
-            refnum = self._references.index(ref) + 1
-            reflst_long.append(refnum)
-        reftxt = self.get_sequence(reflst_long)
-        self.paragraph.add_run(reftxt).font.superscript = True
-        self.paragraph.add_run(']').font.superscript = True
-
-    @staticmethod
-    def get_sequence(stringlist: list[int]) -> str:
-        """
-        Converts a list of numbers into a string of numbers where recurring sequences
-        are described with a range.
-
-        >>> ReferenceList.get_sequence([1, 3, 4, 5, 6, 8, 11])
-        '1,3-6,8,11'
-        """
-        folg = []
-        start = 0
-        for n, val in enumerate(stringlist):
-            val = int(val)
-            nextval = 0
-            with suppress(IndexError):
-                nextval = int(stringlist[n + 1])
-            nextnext = 0
-            with suppress(IndexError):
-                nextnext = int(stringlist[n + 2])
-            # a sequence starts:
-            if nextnext == val + 2 and not start:
-                start = val
-            # in a sequence and next value is not +1 -> squence ends with val:
-            if start and nextval != val + 1:
-                folg.append(f'{start}-{val}')
-                start = 0
-                continue
-            # everything outside a sequence:
-            if not start:
-                folg.append(val)
-        return ','.join([str(x) for x in folg])
-
-    def make_literature_list(self, document):
-        if len(self._references) < 10:
-            template = 'references_ni'
-        else:
-            template = 'references'
-        for num, ref in enumerate(self._references, 1):
-            paragraph_reflist = document.add_paragraph('', template)
-            paragraph_reflist.add_run(f'[{num!s}] \t')
-            ref.add_reference(paragraph_reflist)
-
-    def __repr__(self):
-        return '\n'.join([f'[{num}] {x}' for num, x in enumerate(self._references)])
-
-
 class Reference:
     def __init__(self):
         self.authors = ''
@@ -137,31 +50,6 @@ class Reference:
         self.program = ''
         self.count = 0
 
-    def add_reference(self, p: Paragraph) -> None:
-        if self.authors:
-            p.add_run(self.authors)
-            p.add_run(', ')
-        if self.journal:
-            p.add_run(self.journal).italic = True
-            if not self.journal.endswith('.'):
-                p.add_run(', ')
-            else:
-                p.add_run(' ')
-        if self.year:
-            p.add_run(self.year).bold = True
-            p.add_run(', ')
-        if self.volume:
-            p.add_run(self.volume).italic = True
-            p.add_run(', ')
-        if self.pages:
-            p.add_run(self.pages)
-            if self.doi:
-                p.add_run(', ')
-        if self.doi:
-            p.add_run(self.doi)
-        if any([self.journal, self.pages, self.year, self.volume, self.doi]):
-            p.add_run('.')
-
     @property
     def richtext(self) -> RichText:
         r = RichText('')
@@ -589,8 +477,3 @@ class CrysalisProReference(Reference):
         self.journal = version
         self.year = year
         self.pages = pages
-
-
-if __name__ == '__main__':
-    r = ReferenceList.get_sequence([1, 2, 3, 6])
-    print(r)

{finalcif-177 → finalcif-178}/finalcif/report/report_text.py

@@ -1,18 +1,14 @@
 import os
 
 import gemmi
-from docx import Document
 from docx.oxml.xmlchemy import BaseOxmlElement
-from docx.text.paragraph import Paragraph
-from docx.text.run import Run
 from lxml import etree
 from lxml.etree import XSLTAccessControl
 
 from finalcif.app_path import application_path
 from finalcif.cif.cif_file_io import CifContainer
 from finalcif.cif.text import retranslate_delimiter, string_to_utf8
-from finalcif.report import references
-from finalcif.tools.misc import (protected_space, angstrom, remove_line_endings)
+from finalcif.tools.misc import angstrom, remove_line_endings
 
 
 def math_to_word(eq: str) -> BaseOxmlElement:
@@ -57,41 +53,6 @@ def _get_cooling_device(cif: CifContainer) -> str:
         return ''
 
 
-class FormatMixin:
-
-    def bold(self, run: Run):
-        r = run.bold = True
-        return r
-
-
-class SpaceChar:
-    def __init__(self, paragraph: Paragraph):
-        self.p = paragraph
-
-    def regular(self) -> None:
-        self.p.add_run(' ')
-
-    def protected(self):
-        self.p.add_run(protected_space)
-
-
-class RefinementDetails:
-    def __init__(self, cif: CifContainer, document: Document):
-        ph = document.add_paragraph(style='Heading 2')
-        ph.add_run(text=fr"Refinement details for {cif.block.name}")
-        p = document.add_paragraph()
-        try:
-            p.style = document.styles['fliesstext']
-        except KeyError:
-            print('DBG> Text style not found')
-        text = ' '.join(cif['_refine_special_details'].splitlines(keepends=False))
-        if cif['_olex2_refine_details']:
-            text += ' '.join(cif['_olex2_refine_details'].splitlines(keepends=False))
-        # Replacing semicolon, because it can damage the CIF:
-        text = text.replace(';', '.')
-        p.add_run(string_to_utf8(text).strip())
-
-
 def get_inf_article(next_word: str) -> str:
     if not next_word:
         return 'a'
@@ -133,13 +94,3 @@ def format_radiation(radiation_type: str) -> list:
         return radtype
     else:
         return radtype
-
-
-def make_report_text(cif, document: Document) -> references.ReferenceList:
-    paragr = document.add_paragraph()
-    try:
-        paragr.style = document.styles['fliesstext']
-    except KeyError:
-        print('DBG> Text style not found')
-    ref = references.ReferenceList(paragr)
-    return ref

{finalcif-177 → finalcif-178}/finalcif/report/templated_report.py

@@ -13,7 +13,7 @@ from collections.abc import Callable
 from contextlib import suppress
 from math import sin, radians
 from pathlib import Path
-from typing import Any
+from typing import Any, Literal
 
 from qtpy.QtWidgets import QApplication
 
@@ -725,7 +725,7 @@ class Formatter(abc.ABC):
         if 'OLEX' in refined.upper():
             self.literature['refinement'] = ref.Olex2Reference()
         if ('NOSPHERA2' in refined.upper() or 'NOSPHERA2' in cif['_refine_special_details'].upper() or
-            'NOSPHERAT2' in cif['_olex2_refine_details'].upper()):
+                'NOSPHERAT2' in cif['_olex2_refine_details'].upper()):
             self.literature['refinement'] = ref.Nosphera2Reference()
         return string_to_utf8(refined.split('(')[0]).strip()
 
@@ -779,11 +779,28 @@ class Formatter(abc.ABC):
                                   U23=u23.replace('-', minus_sign))
                      for label, u11, u22, u33, u23, u13, u12 in cif.displacement_parameters())
 
-    def get_completeness(self, cif: CifContainer) -> str:
+    def get_completeness(self, cif: CifContainer, theta_limit: Literal['full', 'max'] = 'full') -> str:
+        """
+        Completeness in % for the given theta limit ('full' or 'max').
+        The standard CIF values used to report the completeness are
+        _diffrn_measured_fraction_theta_max and _diffrn_measured_fraction_theta_full.
+
+        How they differ
+        _diffrn_measured_fraction_theta_full:
+        Reports the fraction of independent reflections measured up to a standardized
+        "full" resolution limit (e.g., theta = 25.2° for Mo-K⍺
+        or 67.5° for Cu-K⍺). This is the metric most rigorously checked for publication.
+
+        _diffrn_measured_fraction_theta_max:
+        Reports the fraction of independent reflections measured up to the absolute highest
+        angle collected in that specific experiment, even if it exceeds or falls short of
+        the standard resolution limit.
+        """
+        fraction = cif[f'_diffrn_measured_fraction_theta_{theta_limit}']
         try:
-            completeness = f"{float(cif['_diffrn_measured_fraction_theta_max']) * 100:.1f}"
+            completeness = f"{float(fraction) * 100:.1f}"
         except ValueError:
-            completeness = cif['_diffrn_measured_fraction_theta_max']
+            completeness = fraction
         return completeness
 
     def format_experiment_table(self, cif: CifContainer):
@@ -1122,6 +1139,7 @@ class TemplatedReport:
         self.options = options
         self.text_formatter = text_factory(options, cif)[self.format]
         self.references = {}
+        self.is_multi_cif_template = False
 
     def count_reference(self, ref):
         if self.references:
@@ -1167,6 +1185,8 @@ class TemplatedReport:
         # plain text full reference:
         jinja_env.filters['ref_txt'] = self.reference_text
         try:
+            variables = tpl_doc.get_undeclared_template_variables(jinja_env=jinja_env)
+            self.is_multi_cif_template = bool({'blocklist', 'block'} & variables)
             tpl_doc.render(context, jinja_env=jinja_env, autoescape=True)
             tpl_doc.save(output_filename)
             return True
@@ -1180,7 +1200,6 @@ class TemplatedReport:
             show_general_warning(parent=None, window_title='Warning', warn_text='Document generation failed',
                                  info_text=str(e))
             print(e)
-            raise
             return False
 
     def make_templated_html_report(self,
@@ -1298,10 +1317,10 @@ class TemplatedReport:
                    'space_group'            : self.text_formatter.space_group_formatted(cif, tpl_doc),
                    'structure_figure'       : self.text_formatter.make_picture(options,
                                                                                options.structure_figure, tpl_doc) if (
-                       options and options.report_text) else '',
+                           options and options.report_text) else '',
                    'crystal_video'          : self.text_formatter.make_picture(options,
                                                                                options.video_image, tpl_doc) if (
-                       options and options.report_text) else '',
+                           options and options.report_text) else '',
                    '3d_structure'           : self.text_formatter.make_3d(cif, options) if options else '',
                    'crystallization_method' : self.text_formatter.get_crystallization_method(cif),
                    'sum_formula'            : self.text_formatter.format_sum_formula(
@@ -1332,8 +1351,11 @@ class TemplatedReport:
                    'indepentent_refl'       : this_or_quest(cif['_reflns_number_total']),
                    'r_int'                  : this_or_quest(cif['_diffrn_reflns_av_R_equivalents']),
                    'r_sigma'                : this_or_quest(cif['_diffrn_reflns_av_unetI/netI']),
-                   'completeness'           : self.text_formatter.get_completeness(cif),
+                   'completeness'           : self.text_formatter.get_completeness(cif, 'full'),
+                   'completeness_theta_full': self.text_formatter.get_completeness(cif, 'full'),
+                   'completeness_theta_max' : self.text_formatter.get_completeness(cif, 'max'),
                    'theta_full'             : cif['_diffrn_reflns_theta_full'],
+                   'theta_max'              : cif['_diffrn_reflns_theta_max'],
                    'resolution_angstrom'    : self.text_formatter.get_angstrom_resolution(cif),
                    'redundancy'             : self.text_formatter.get_redundancy(cif),
                    'data'                   : this_or_quest(cif['_refine_ls_number_reflns']),
@@ -1475,15 +1497,15 @@ if __name__ == '__main__':
 
     import subprocess
 
-    report_type = ReportFormat.LATEX
+    report_type = ReportFormat.HTML
 
     data = Path('tests')
     testcif = Path(data / 'examples/1979688.cif').absolute()
-    testcif = Path(data / r'..\test-data\4060314.cif').absolute()
+    # testcif = Path(data / r'..\test-data\4060314.cif').absolute()
 
     # testcif = Path(r'test-data/p31c.cif').absolute()
-    #testcif = Path(r'test-data/p31c.cif').absolute()
-    #testcif = Path(r"D:\Downloads\9008564.cif").absolute()
+    # testcif = Path(r'test-data/p31c.cif').absolute()
+    # testcif = Path(r"D:\Downloads\9008564.cif").absolute()
     cif = CifContainer(testcif)
 
     pic = pathlib.Path("screenshots/finalcif_checkcif.png")

{finalcif-177 → finalcif-178}/finalcif/template/report.tmpl

@@ -250,11 +250,16 @@
                 </td>
             </tr>
             <tr>
-                <td>Completeness{% if cif._diffrn_reflns_theta_max %} to
-                    θ = {{ cif._diffrn_reflns_theta_max|float_num(2) }}°
-                {% endif %}
+                <td>Completeness{% if theta_full %} to
+                    θ = {{ theta_full|float_num(2) }}°{% endif %}
+                </td>
+                <td>{{ completeness_theta_full }}%</td>
+            </tr>
+            <tr>
+                <td>Completeness{% if theta_max %} to
+                    θ = {{ theta_max|float_num(2) }}°{% endif %}
                 </td>
-                <td>{{ completeness }}%</td>
+                <td>{{ completeness_theta_max }}%</td>
             </tr>
             <tr>
                 <td>Data / Restraints / Parameters</td>

{finalcif-177 → finalcif-178}/finalcif/template/report_fastmolwidget.tmpl

@@ -289,11 +289,16 @@
                 </td>
             </tr>
             <tr>
-                <td>Completeness{% if cif._diffrn_reflns_theta_max %} to
-                    θ = {{ cif._diffrn_reflns_theta_max|float_num(2) }}°
-                {% endif %}
+                <td>Completeness{% if theta_full %} to
+                    θ = {{ theta_full|float_num(2) }}°{% endif %}
+                </td>
+                <td>{{ completeness_theta_full }}%</td>
+            </tr>
+            <tr>
+                <td>Completeness{% if theta_max %} to
+                    θ = {{ theta_max|float_num(2) }}°{% endif %}
                 </td>
-                <td>{{ completeness }}%</td>
+                <td>{{ completeness_theta_max }}%</td>
             </tr>
             <tr>
                 <td>Data / Restraints / Parameters</td>

finalcif-178/githooks/pre-push

@@ -0,0 +1,76 @@
+#!/bin/sh
+#
+# pre-push hook: reject pushing version tags (e.g. "version-177") whose
+# numeric version is newer than the VERSION defined in finalcif/__init__.py
+# at the commit the tag points to.
+#
+# Git has no client-side hook that fires on local `git tag` creation, so
+# this is enforced at push time instead, which is the last point before
+# the tag becomes visible to others.
+#
+# Install (once per clone):
+#   git config core.hooksPath githooks
+#
+# Tag names are expected to look like "version-NNN" (matching VERSION = NN).
+# Tags that don't match this pattern are ignored by this check.
+
+VERSION_FILE="finalcif/__init__.py"
+z40="0000000000000000000000000000000000000000"
+
+reject=0
+
+while read -r local_ref local_sha remote_ref remote_sha; do
+    case "$local_ref" in
+        refs/tags/*) ;;
+        *) continue ;;
+    esac
+
+    # Tag deletion (local_sha is all zeros) - nothing to check.
+    if [ "$local_sha" = "$z40" ]; then
+        continue
+    fi
+
+    tag_name=${local_ref#refs/tags/}
+
+    # Only enforce the check for tags named like "version-<number>".
+    case "$tag_name" in
+        version-[0-9]*)
+            tag_version=${tag_name#version-}
+            case "$tag_version" in
+                *[!0-9]*) continue ;;  # not purely numeric, skip
+            esac
+            ;;
+        *) continue ;;
+    esac
+
+    # Resolve to the commit the tag points at (handles annotated tags).
+    commit_sha=$(git rev-list -n 1 "$local_sha" 2>/dev/null)
+    if [ -z "$commit_sha" ]; then
+        commit_sha="$local_sha"
+    fi
+
+    file_content=$(git show "$commit_sha:$VERSION_FILE" 2>/dev/null)
+    if [ -z "$file_content" ]; then
+        echo "pre-push: warning: could not read $VERSION_FILE at $commit_sha for tag $tag_name; skipping check" >&2
+        continue
+    fi
+
+    file_version=$(printf '%s\n' "$file_content" | sed -n "s/^VERSION *= *\\([0-9]\\+\\).*/\\1/p" | head -n 1)
+    if [ -z "$file_version" ]; then
+        echo "pre-push: warning: could not parse VERSION from $VERSION_FILE at $commit_sha; skipping check" >&2
+        continue
+    fi
+
+    if [ "$tag_version" -gt "$file_version" ]; then
+        echo "pre-push: rejected: tag '$tag_name' (version $tag_version) is newer than" >&2
+        echo "          VERSION = $file_version in $VERSION_FILE at commit $commit_sha." >&2
+        echo "          Update $VERSION_FILE to $tag_version before tagging/pushing." >&2
+        reject=1
+    fi
+done
+
+if [ "$reject" -eq 1 ]; then
+    exit 1
+fi
+
+exit 0