Remove utils.xml_generator and utils.xml_output_version

These two variables should not have made it into the public API. There is no
deprecation cycle for these because of the complexity of keeping these
module attributes around.

This allows now to completely get rid of the writing of these values
during the different caching processes.

Author: iMichka

CHANGELOG.md

@@ -23,6 +23,11 @@ Version 1.9.0 (not yet released)
   and ```remove_elaborated``` function.
   This is only available when setting the ```castxml_epic_version``` flag to 1 .
 
+* Removed ```utils.xml_generator``` and ```utils.xml_output_version``` attributes.
+  These two variables should not have made it into the public API. There is no
+  deprecation cycle for these because of the complexity of keeping these
+  module attributes around.
+
 * Deprecated ```decl``` attribute from ```dependency_info_t```. Use ```declaration```
   instead.
 

pygccxml/parser/declarations_cache.py

@@ -102,13 +102,11 @@ class record_t(object):
 
     def __init__(
             self,
-            xml_generator,
             source_signature,
             config_signature,
             included_files,
             included_files_signature,
             declarations):
-        self.__xml_generator = xml_generator
         self.__source_signature = source_signature
         self.__config_signature = config_signature
         self.__included_files = included_files
@@ -153,10 +151,6 @@ def included_files_signature(self):
     def declarations(self):
         return self.__declarations
 
-    @property
-    def xml_generator(self):
-        return self.__xml_generator
-
 
 class file_cache_t(cache_base_t):
 
@@ -180,23 +174,6 @@ def __init__(self, name):
             self.__cache)  # If empty then we need to flush
         for entry in self.__cache.values():  # Clear hit flags
             entry.was_hit = False
-            try:
-                # Make sure the xml_generator variable is defined, else it
-                # will stay None.
-                xml_generator = entry.xml_generator
-            except AttributeError:
-                msg = (
-                    "The %s cache file is not compatible with this version " +
-                    "of pygccxml. Please regenerate it.") % name
-                raise RuntimeError(msg)
-            if not utils.xml_generator:
-                # Set the xml_generator to the one read in the cache file
-                utils.xml_generator = xml_generator
-            elif utils.xml_generator != xml_generator:
-                msg = (
-                    "The %s cache file was generated with a different xml " +
-                    "generator. Please regenerate it.") % name
-                raise RuntimeError(msg)
 
     @staticmethod
     def __load(file_name):
@@ -258,7 +235,6 @@ def update(self, source_file, configuration, declarations, included_files):
         """ Update a cached record with the current key and value contents. """
 
         record = record_t(
-            xml_generator=utils.xml_generator,
             source_signature=file_signature(source_file),
             config_signature=configuration_signature(configuration),
             included_files=included_files,

pygccxml/parser/directory_cache.py

@@ -27,7 +27,6 @@
     import pickle
 
 from . import declarations_cache
-from .. import utils
 
 
 class index_entry_t(object):
@@ -252,10 +251,6 @@ def _load(self):
             self.__index = {}
             self.__filename_rep = filename_repository_t(self.__sha1_sigs)
 
-        # Read the xml generator from the cache and set it
-        with open(os.path.join(self.__dir, "gen.dat"), "r") as gen_file:
-            utils.xml_generator = gen_file.read()
-
         self.__modified_flag = False
 
     def _save(self):
@@ -274,10 +269,6 @@ def _save(self):
                 (self.__index,
                  self.__filename_rep))
 
-            # Read the xml generator from the cache and set it
-            with open(os.path.join(self.__dir, "gen.dat"), "w") as gen_file:
-                gen_file.write(utils.xml_generator)
-
             self.__modified_flag = False
 
     def _read_file(self, filename):

pygccxml/parser/scanner.py

@@ -680,6 +680,5 @@ def __read_version(self, attrs):
             gccxml_cvs_revision = attrs.get(XML_AN_CVS_REVISION)
         xml_generator = utils.xml_generators(
             utils.loggers.cxx_parser, gccxml_cvs_revision, castxml_format)
-        utils.xml_generator = xml_generator.get_string_repr()
         utils.xml_output_version = gccxml_cvs_revision
         self.__xml_generator_from_xml_file = xml_generator

pygccxml/utils/__init__.py

@@ -18,7 +18,3 @@
 from .utils import get_tr1
 from .utils import cxx_standard
 from .xml_generators import xml_generators
-
-# Version of xml generator which was used.
-xml_generator = ""
-xml_output_version = ""

unittests/core_tester.py

@@ -524,9 +524,6 @@ def test_abstract_classes(self):
             not implementation.is_abstract,
             "class 'implementation' should not be abstract")
 
-    def test_versioning(self):
-        self.assertTrue(utils.xml_generator)
-
     def test_byte_size(self):
         mptrs = self.global_ns.class_('members_pointers_t')
         self.assertTrue(mptrs.byte_size != 0)

unittests/data/new_cache.cache

@@ -82,32 +82,6 @@ def test_from_file(self):
             ("cached declarations and source declarations are different, " +
                 "after pickling"))
 
-    @staticmethod
-    def test_reopen_cache():
-        """
-        Test opening cache files in a subprocess (with a clean environment).
-
-        """
-
-        env = os.environ.copy()
-
-        # Get the path to current directory
-        path = os.path.dirname(os.path.realpath(__file__))
-        # Set the COVERAGE_PROCESS_START env. variable.
-        # Allows to cover files run in a subprocess
-        # http://nedbatchelder.com/code/coverage/subprocess.html
-        env["COVERAGE_PROCESS_START"] = path + "/../.coveragerc"
-
-        p = subprocess.Popen(
-            [sys.executable, "unittests/reopen_cache_tester.py"],
-            stderr=subprocess.PIPE,
-            env=env)
-        p.wait()
-        error = p.stderr.read().decode("utf-8").rstrip()
-        p.stderr.close()
-        if p.returncode != 0:
-            raise Exception(error)
-
 
 def create_suite():
     suite = unittest.TestSuite()

unittests/data/old_cache.cache

@@ -12,7 +12,6 @@
 from . import parser_test_case
 
 from pygccxml import parser
-from pygccxml import utils
 
 
 class Test(parser_test_case.parser_test_case_t):
@@ -41,7 +40,6 @@ def test_directory_cache_without_compression(self):
         parser.parse([self.header], self.config, cache=cache)
         # Read from the cache the second time
         parser.parse([self.header], self.config, cache=cache)
-        self.assertIsNotNone(utils.xml_generator)
 
     def test_directory_cache_with_compression(self):
         """
@@ -55,7 +53,6 @@ def test_directory_cache_with_compression(self):
         parser.parse([self.header], self.config, cache=cache)
         # Read from the cache the second time
         parser.parse([self.header], self.config, cache=cache)
-        self.assertIsNotNone(utils.xml_generator)
 
     def test_dir_compatibility(self):
         """
@@ -74,8 +71,6 @@ def test_dir_compatibility(self):
         # Reset this warning to always
         warnings.simplefilter("error", DeprecationWarning)
 
-        self.assertIsNotNone(utils.xml_generator)
-
     def test_directory_cache_twice(self):
         """
         Setup two caches in a row.
@@ -87,8 +82,6 @@ def test_directory_cache_twice(self):
         cache = parser.directory_cache_t(directory=self.cache_dir)
         parser.parse([self.header], self.config, cache=cache)
 
-        self.assertIsNotNone(utils.xml_generator)
-
     def test_directory_existing_dir(self):
         """
         Setup a cache when there is already a file at the cache's location.