more bugfix

Author: tobixen

CHANGELOG.md

@@ -21,10 +21,12 @@ Python 3.7 is no longer tested - but it should work.  Please file a bug report i
 ### Changed
 
 * Some exotic servers may return object URLs on search, but it does not work out to fetch the calendar data.  Now it will log an error instead of raising an error in such cases.
+* The `tests/compatibility_issues.py` has been moved to `caldav/compatibility_hints.py`, this to make it available for a caldav-server-tester-tool that I'm splitting off to a separate project/repository, and also to make https://github.com/python-caldav/caldav/issues/402 possible.
 
 #### Refactoring
 
 * Minor code cleanups by github user @ArtemIsmagilov in https://github.com/python-caldav/caldav/pull/456
+* The very much overgrown `objects.py`-file has been split into three.
 
 #### Test framework
 

tests/compatibility_issues.py caldav/compatibility_hints.pytests/compatibility_issues.py renamed to caldav/compatibility_hints.py

@@ -1,4 +1,23 @@
 # fmt: off
+"""This text was updated 2025-05-17.  The plan is to reorganize this
+file a lot over the next few months, see
+https://github.com/python-caldav/caldav/issues/402
+
+This file serves as a database of different compatibility issues we've
+encountered while working on the caldav library, and descriptions on
+how the well-known servers behave.
+
+As for now, this is a list of binary "flags" that could be turned on
+or off.  My experience is that there are often neuances, so the
+compatibility matrix will be changed from being a list of flags to a
+key=value store in the near future (at least, that's the plan).
+
+The issues may be grouped together, maybe even organized
+hierarchically.  I did consider organizing the compatibility issues in
+some more advanced way, but I don't want to overcomplicate things - I
+will try out the key-value-approach first.
+"""
+
 ## The lists below are specifying what tests should be skipped or
 ## modified to accept non-conforming resultsets from the different
 ## calendar servers.  In addition there are some hacks in the library

docs/source/index.rst

@@ -307,7 +307,7 @@ Compatibility
 tend to be a moving target, and I rarely recheck if things works in
 newer versions of the software after I find an incompatibility)
 
-The test suite is regularly run against several calendar servers, see https://github.com/python-caldav/caldav/issues/45 for the latest updates.  See ``tests/compatibility_issues.py`` for the most up-to-date list of compatibility issues.  In early versions of this library test breakages was often an indication that the library did not conform well enough to the standards, but as of today it mostly indicates that the servers does not support the standard well enough.  It may be an option to add tweaks to the library code to cover some of the missing functionality.
+The test suite is regularly run against several calendar servers, see https://github.com/python-caldav/caldav/issues/45 for the latest updates.  See ``compatibility_hints.py`` for the most up-to-date list of compatibility issues.  In early versions of this library test breakages was often an indication that the library did not conform well enough to the standards, but as of today it mostly indicates that the servers does not support the standard well enough.  It may be an option to add tweaks to the library code to cover some of the missing functionality.
 
 Here are some known issues:
 

tests/conf.py

@@ -10,7 +10,7 @@
 
 import niquests
 
-from . import compatibility_issues
+from caldav import compatibility_hints
 from caldav.davclient import DAVClient
 
 ####################################
@@ -140,7 +140,7 @@ def teardown_radicale(self):
             "username": "user1",
             "password": "",
             "backwards_compatibility_url": url + "user1",
-            "incompatibilities": compatibility_issues.radicale,
+            "incompatibilities": compatibility_hints.radicale,
             "setup": setup_radicale,
             "teardown": teardown_radicale,
         }
@@ -225,7 +225,7 @@ def silly_request():
             "name": "LocalXandikos",
             "url": url,
             "backwards_compatibility_url": url + "sometestuser",
-            "incompatibilities": compatibility_issues.xandikos,
+            "incompatibilities": compatibility_hints.xandikos,
             "setup": setup_xandikos,
             "teardown": teardown_xandikos,
         }

tests/conf_private.py.EXAMPLE

@@ -1,4 +1,4 @@
-from tests import compatibility_issues
+from caldav import compatibility_hints
 
 ## PRIVATE CALDAV SERVER(S) TO RUN TESTS TOWARDS
 ## Make a list of your own servers/accounts that you'd like to run the
@@ -29,8 +29,8 @@ caldav_servers = [
 
         ## incompatibilities is a list of flags that can be set for
         ## skipping (parts) of certain tests.  See
-        ## tests/compatibility_issues.py for premade lists
-        #'incompatibilities': compatibility_issues.nextcloud
+        ## compatibility_hints.py for premade lists
+        #'incompatibilities': compatibility_hints.nextcloud
       	'incompatibilities': [],
 
         ## You may even add setup and teardown methods to set up

tests/test_caldav.py

@@ -25,7 +25,7 @@
 import pytest
 import vobject
 
-from . import compatibility_issues
+from caldav import compatibility_hints
 from .conf import caldav_servers
 from .conf import client
 from .conf import proxy
@@ -581,12 +581,12 @@ class RepeatedFunctionalTestsBaseClass:
 
     def check_compatibility_flag(self, flag):
         ## yield an assertion error if checking for the wrong thig
-        assert flag in compatibility_issues.incompatibility_description
+        assert flag in compatibility_hints.incompatibility_description
         return flag in self.incompatibilities
 
     def skip_on_compatibility_flag(self, flag):
         if self.check_compatibility_flag(flag):
-            msg = compatibility_issues.incompatibility_description[flag]
+            msg = compatibility_hints.incompatibility_description[flag]
             pytest.skip("Test skipped due to server incompatibility issue: " + msg)
 
     def setup_method(self):
@@ -596,7 +596,7 @@ def setup_method(self):
         self.calendars_used = []
 
         for flag in self.server_params.get("incompatibilities", []):
-            assert flag in compatibility_issues.incompatibility_description
+            assert flag in compatibility_hints.incompatibility_description
             self.incompatibilities.add(flag)
 
         if self.check_compatibility_flag("unique_calendar_ids"):