From e0f5c7f4fd42f714af9ca1b158dced09ad63da3d Mon Sep 17 00:00:00 2001 From: github-actions Date: Tue, 17 Dec 2024 09:43:47 +0000 Subject: [PATCH] Updated documentation --- _modules/apis_core/utils/DateParser.html | 82 ---------------- _modules/apis_core/utils/test_DateParser.html | 19 +--- genindex.html | 10 +- htmlcov/class_index.html | 28 +++--- htmlcov/function_index.html | 46 +++------ htmlcov/index.html | 20 ++-- htmlcov/manage_py.html | 4 +- htmlcov/status.json | 2 +- htmlcov/z_079cb04380c5d241_DateParser_py.html | 90 ++---------------- htmlcov/z_079cb04380c5d241___init___py.html | 4 +- .../z_079cb04380c5d241_authentication_py.html | 4 +- .../z_079cb04380c5d241_autocomplete_py.html | 4 +- htmlcov/z_079cb04380c5d241_fields_py.html | 4 +- htmlcov/z_079cb04380c5d241_filters_py.html | 4 +- htmlcov/z_079cb04380c5d241_helpers_py.html | 4 +- htmlcov/z_079cb04380c5d241_normalize_py.html | 4 +- htmlcov/z_079cb04380c5d241_rdf_py.html | 4 +- htmlcov/z_079cb04380c5d241_settings_py.html | 4 +- ...z_079cb04380c5d241_test_DateParser_py.html | 62 ++++++------ .../z_079cb04380c5d241_test_helpers_py.html | 4 +- .../z_079cb04380c5d241_test_normalize_py.html | 4 +- htmlcov/z_079cb04380c5d241_test_rdf_py.html | 4 +- htmlcov/z_0b6d599bfac90e15___init___py.html | 4 +- ...6d599bfac90e15_test_simple_history_py.html | 4 +- htmlcov/z_18f121dc3730a25c___init___py.html | 4 +- htmlcov/z_18f121dc3730a25c_api_views_py.html | 4 +- htmlcov/z_18f121dc3730a25c_apps_py.html | 4 +- htmlcov/z_18f121dc3730a25c_models_py.html | 4 +- .../z_18f121dc3730a25c_serializers_py.html | 4 +- htmlcov/z_18f121dc3730a25c_tables_py.html | 4 +- htmlcov/z_18f121dc3730a25c_urls_py.html | 4 +- htmlcov/z_18f121dc3730a25c_utils_py.html | 4 +- htmlcov/z_18f121dc3730a25c_views_py.html | 4 +- htmlcov/z_210622b261945b4b_core_py.html | 4 +- htmlcov/z_2117b3d262c5684b_urls_py.html | 4 +- htmlcov/z_2117b3d262c5684b_utils_py.html | 4 +- htmlcov/z_2117b3d262c5684b_views_py.html | 4 +- htmlcov/z_2c9c277fca33aa93___init___py.html | 4 +- htmlcov/z_2c9c277fca33aa93_urls_py.html | 4 +- htmlcov/z_2d258017742203c3_generic_py.html | 4 +- htmlcov/z_38054c303eea2897_history_py.html | 4 +- htmlcov/z_3eb2033f4386aef4___init___py.html | 4 +- htmlcov/z_3eb2033f4386aef4_apps_py.html | 4 +- htmlcov/z_3eb2033f4386aef4_forms_py.html | 4 +- htmlcov/z_3eb2033f4386aef4_models_py.html | 4 +- htmlcov/z_3eb2033f4386aef4_querysets_py.html | 4 +- ...3eb2033f4386aef4_settings_loaddata_py.html | 4 +- htmlcov/z_3eb2033f4386aef4_settings_py.html | 4 +- .../z_3eb2033f4386aef4_settings_tests_py.html | 4 +- htmlcov/z_3eb2033f4386aef4_tables_py.html | 4 +- htmlcov/z_3eb2033f4386aef4_urls_py.html | 4 +- htmlcov/z_49ff5da25a66209a___init___py.html | 4 +- htmlcov/z_49ff5da25a66209a_admin_py.html | 4 +- htmlcov/z_49ff5da25a66209a_apps_py.html | 4 +- htmlcov/z_49ff5da25a66209a_filtersets_py.html | 4 +- htmlcov/z_49ff5da25a66209a_forms_py.html | 4 +- htmlcov/z_49ff5da25a66209a_models_py.html | 4 +- .../z_49ff5da25a66209a_serializers_py.html | 4 +- htmlcov/z_49ff5da25a66209a_tables_py.html | 4 +- htmlcov/z_49ff5da25a66209a_urls_py.html | 4 +- htmlcov/z_49ff5da25a66209a_viewsets_py.html | 4 +- htmlcov/z_572d048ccdded887___init___py.html | 4 +- htmlcov/z_572d048ccdded887_abc_py.html | 4 +- htmlcov/z_572d048ccdded887_api_views_py.html | 4 +- htmlcov/z_572d048ccdded887_apps_py.html | 4 +- .../z_572d048ccdded887_autocomplete3_py.html | 4 +- htmlcov/z_572d048ccdded887_fields_py.html | 4 +- htmlcov/z_572d048ccdded887_filtersets_py.html | 4 +- htmlcov/z_572d048ccdded887_models_py.html | 4 +- .../z_572d048ccdded887_serializers_py.html | 4 +- htmlcov/z_572d048ccdded887_tables_py.html | 4 +- htmlcov/z_572d048ccdded887_urls_py.html | 4 +- htmlcov/z_572d048ccdded887_utils_py.html | 4 +- htmlcov/z_572d048ccdded887_views_py.html | 4 +- .../z_5d8b244af5c2277b_0001_initial_py.html | 4 +- ...b_0002_property_property_class_uri_py.html | 4 +- ...4af5c2277b_0003_auto_20230123_1715_py.html | 4 +- ...4af5c2277b_0004_auto_20230124_1201_py.html | 4 +- ...bj_class_alter_property_subj_class_py.html | 4 +- ...44af5c2277b_0006_versiontemptriple_py.html | 4 +- ...07_alter_versiontemptriple_options_py.html | 4 +- htmlcov/z_5d8b244af5c2277b___init___py.html | 4 +- htmlcov/z_73d20026d8cfd537___init___py.html | 4 +- htmlcov/z_73d20026d8cfd537_admin_py.html | 4 +- htmlcov/z_73d20026d8cfd537_apps_py.html | 4 +- htmlcov/z_73d20026d8cfd537_models_py.html | 4 +- htmlcov/z_73d20026d8cfd537_signals_py.html | 4 +- htmlcov/z_73d20026d8cfd537_tables_py.html | 4 +- htmlcov/z_73d20026d8cfd537_urls_py.html | 4 +- htmlcov/z_73d20026d8cfd537_views_py.html | 4 +- htmlcov/z_742a021fcfacff1d___init___py.html | 4 +- htmlcov/z_742a021fcfacff1d_admin_py.html | 4 +- htmlcov/z_742a021fcfacff1d_apps_py.html | 4 +- htmlcov/z_742a021fcfacff1d_filters_py.html | 4 +- htmlcov/z_742a021fcfacff1d_filtersets_py.html | 4 +- htmlcov/z_742a021fcfacff1d_forms_py.html | 4 +- htmlcov/z_742a021fcfacff1d_models_py.html | 4 +- htmlcov/z_742a021fcfacff1d_signals_py.html | 4 +- htmlcov/z_742a021fcfacff1d_tables_py.html | 4 +- htmlcov/z_742a021fcfacff1d_urls_py.html | 4 +- htmlcov/z_742a021fcfacff1d_utils_py.html | 4 +- htmlcov/z_742a021fcfacff1d_views_py.html | 4 +- .../z_754a3a2495383e43_0001_initial_py.html | 4 +- ...3_0002_remove_tempentityclass_text_py.html | 4 +- ...0003_remove_tempentityclass_source_py.html | 4 +- ...383e43_0004_delete_tempentityclass_py.html | 4 +- htmlcov/z_754a3a2495383e43___init___py.html | 4 +- htmlcov/z_75fef824206db77b_relations_py.html | 4 +- .../z_782cd176b95f1058_0001_initial_py.html | 4 +- ..._0002_alter_skoscollection_options_py.html | 4 +- ...ection_unique_name_parent_and_more_py.html | 4 +- htmlcov/z_782cd176b95f1058___init___py.html | 4 +- htmlcov/z_87b47be0c3172b83___init___py.html | 4 +- htmlcov/z_87b47be0c3172b83_admin_py.html | 4 +- htmlcov/z_87b47be0c3172b83_apps_py.html | 4 +- htmlcov/z_87b47be0c3172b83_filtersets_py.html | 4 +- htmlcov/z_87b47be0c3172b83_forms_py.html | 4 +- htmlcov/z_87b47be0c3172b83_models_py.html | 4 +- htmlcov/z_87b47be0c3172b83_querysets_py.html | 4 +- .../z_87b47be0c3172b83_serializers_py.html | 4 +- htmlcov/z_87b47be0c3172b83_signals_py.html | 4 +- htmlcov/z_87b47be0c3172b83_tables_py.html | 4 +- htmlcov/z_87b47be0c3172b83_urls_py.html | 4 +- htmlcov/z_87b47be0c3172b83_utils_py.html | 4 +- htmlcov/z_87b47be0c3172b83_views_py.html | 4 +- .../z_917923bad02a23ec_0001_initial_py.html | 4 +- ...sinof_ispartof_issiblingof_livesin_py.html | 4 +- ...lter_versiongroup_options_and_more_py.html | 4 +- htmlcov/z_917923bad02a23ec___init___py.html | 4 +- htmlcov/z_9e462fdf71a95359___init___py.html | 4 +- htmlcov/z_9e462fdf71a95359_fields_py.html | 4 +- htmlcov/z_9e462fdf71a95359_widgets_py.html | 4 +- htmlcov/z_a87bbc0055e2906a___init___py.html | 4 +- htmlcov/z_a87bbc0055e2906a_tests_py.html | 4 +- htmlcov/z_b98ef7dc8a4f2930_mixins_py.html | 4 +- htmlcov/z_b98ef7dc8a4f2930_models_py.html | 4 +- htmlcov/z_b98ef7dc8a4f2930_urls_py.html | 4 +- htmlcov/z_b98ef7dc8a4f2930_views_py.html | 4 +- .../z_bacc1c03c9be4470_apis_relations_py.html | 4 +- .../z_c3a4d981b07ef925_sample_project_py.html | 4 +- .../z_d10b1e8419087c99_apis_entities_py.html | 4 +- htmlcov/z_d4c4f42115e675b2___init___py.html | 4 +- .../z_d4c4f42115e675b2_collections_py.html | 4 +- .../z_e42e1fb98877cc0c_0001_initial_py.html | 4 +- ...move_texttype_collections_and_more_py.html | 4 +- ...delete_vocabnames_delete_vocabsuri_py.html | 4 +- ...877cc0c_0004_delete_collectiontype_py.html | 4 +- ...77cc0c_0005_delete_vocabsbaseclass_py.html | 4 +- htmlcov/z_e42e1fb98877cc0c___init___py.html | 4 +- .../z_ef4d16bc632aabbd_0001_initial_py.html | 4 +- ...bc632aabbd_0002_auto_20220201_1241_py.html | 4 +- ...bc632aabbd_0003_auto_20220218_1530_py.html | 4 +- ...bc632aabbd_0004_auto_20230310_0804_py.html | 4 +- ...c632aabbd_0005_delete_uricandidate_py.html | 4 +- ..._ef4d16bc632aabbd_0006_delete_text_py.html | 4 +- ...f4d16bc632aabbd_0007_delete_source_py.html | 4 +- ..._alter_rootobject_self_contenttype_py.html | 4 +- ..._remove_collection_collection_type_py.html | 4 +- ...me_name_rootobject_deprecated_name_py.html | 4 +- ...1_alter_rootobject_deprecated_name_py.html | 4 +- ..._remove_rootobject_deprecated_name_py.html | 4 +- ...6bc632aabbd_0013_delete_collection_py.html | 4 +- ..._domain_remove_uri_loaded_and_more_py.html | 4 +- htmlcov/z_ef4d16bc632aabbd___init___py.html | 4 +- htmlcov/z_ef777899a9cfc89e___init___py.html | 4 +- htmlcov/z_ef777899a9cfc89e_abc_py.html | 4 +- htmlcov/z_ef777899a9cfc89e_api_views_py.html | 4 +- .../z_ef777899a9cfc89e_filterbackends_py.html | 4 +- htmlcov/z_ef777899a9cfc89e_filtersets_py.html | 4 +- htmlcov/z_ef777899a9cfc89e_generators_py.html | 4 +- htmlcov/z_ef777899a9cfc89e_helpers_py.html | 4 +- htmlcov/z_ef777899a9cfc89e_importers_py.html | 4 +- htmlcov/z_ef777899a9cfc89e_renderers_py.html | 4 +- htmlcov/z_ef777899a9cfc89e_routers_py.html | 4 +- .../z_ef777899a9cfc89e_serializers_py.html | 4 +- htmlcov/z_ef777899a9cfc89e_signals_py.html | 4 +- htmlcov/z_ef777899a9cfc89e_tables_py.html | 4 +- htmlcov/z_ef777899a9cfc89e_urls_py.html | 4 +- htmlcov/z_ef777899a9cfc89e_views_py.html | 4 +- .../z_f58a2f3fa6848a17_0001_initial_py.html | 4 +- htmlcov/z_f58a2f3fa6848a17___init___py.html | 4 +- modules/apis_core.html | 3 - modules/apis_core.utils.html | 35 ------- objects.inv | Bin 7657 -> 7632 bytes searchindex.js | 2 +- 185 files changed, 421 insertions(+), 666 deletions(-) diff --git a/_modules/apis_core/utils/DateParser.html b/_modules/apis_core/utils/DateParser.html index e34299db0..0e85f89f5 100644 --- a/_modules/apis_core/utils/DateParser.html +++ b/_modules/apis_core/utils/DateParser.html @@ -359,88 +359,6 @@

Source code for apis_core.utils.DateParser

 
     return date_single, date_ab, date_bis
- - -
-[docs] -def get_date_help_text_from_dates( - single_date, single_start_date, single_end_date, single_date_written -): - """ - function for creating string help text from parsed dates, to provide feedback to the user - about the parsing status of a given date field. - - :param single_date: datetime : - the individual date point - :param single_start_date: datetime : - the start range of a date - :param single_end_date: datetime : - the endrange of a date - :param single_date_written: str : - the textual user entry of a date field (needed to check if empty or not) - :return help_text: str : - The text to be displayed underneath a date field, informing the user about the parsing result - """ - - # check which of the dates could be parsed to construct the relevant feedback text - help_text = "" - if single_date: - # single date could be parsed - help_text = "Date interpreted as " - if single_start_date or single_end_date: - # date has also start or end ranges, then ignore single date - if single_start_date: - # date has start range - help_text += ( - str(single_start_date.year) - + "-" - + str(single_start_date.month) - + "-" - + str(single_start_date.day) - + " until " - ) - else: - # date has no start range, then write "undefined" - help_text += "undefined start until " - if single_end_date: - # date has end range - help_text += ( - str(single_end_date.year) - + "-" - + str(single_end_date.month) - + "-" - + str(single_end_date.day) - ) - else: - # date has no start range, then write "undefined" - help_text += "undefined end" - else: - # date has no start nor end range. Use single date then. - help_text += ( - str(single_date.year) - + "-" - + str(single_date.month) - + "-" - + str(single_date.day) - ) - elif single_date_written is not None: - # date input field is not empty but it could not be parsed either. Show parsing info and help text - help_text = ( - "<b>Date could not be interpreted</b><br>" + get_date_help_text_default() - ) - else: - # date field is completely empty. Show help text only - help_text = get_date_help_text_default() - - return help_text
- - - -
-[docs] -def get_date_help_text_default(): - return "Dates are interpreted by defined rules. If this fails, an iso-date can be explicitly set with '&lt;YYYY-MM-DD&gt;'."
- diff --git a/_modules/apis_core/utils/test_DateParser.html b/_modules/apis_core/utils/test_DateParser.html index 6ee3f643c..e620ff9bc 100644 --- a/_modules/apis_core/utils/test_DateParser.html +++ b/_modules/apis_core/utils/test_DateParser.html @@ -88,7 +88,7 @@

Source code for apis_core.utils.test_DateParser

< from django.test import TestCase -from .DateParser import get_date_help_text_from_dates, parse_date +from .DateParser import parse_date help_text_default = "Dates are interpreted by defined rules. If this fails, an iso-date can be explicitly set with '&lt;YYYY-MM-DD&gt;'." @@ -102,26 +102,23 @@

Source code for apis_core.utils.test_DateParser

< # a dict of dates with the written date as key -# followed by a tuple of (single, start, end, help_text) +# followed by a tuple of (single, start, end) dates = { "vor dem 23.10.1449 <1449-10-23>": ( fi("1449-10-23"), None, None, - "Date interpreted as 1449-10-23", ), "1459-12": ( fi("1459-12-16"), fi("1459-12-01"), fi("1459-12-31"), - "Date interpreted as 1459-12-1 until 1459-12-31", ), - "1460-03-30": (fi("1460-03-30"), None, None, "Date interpreted as 1460-3-30"), + "1460-03-30": (fi("1460-03-30"), None, None), "": ( None, None, None, - "<b>Date could not be interpreted</b><br>" + help_text_default, ), } @@ -132,19 +129,11 @@

Source code for apis_core.utils.test_DateParser

<
[docs] def test_dates(self): - for datestring, (expsingle, expstart, expend, help_text) in dates.items(): + for datestring, (expsingle, expstart, expend) in dates.items(): single, start, end = parse_date(datestring) self.assertEqual(expsingle, single) self.assertEqual(expstart, start) self.assertEqual(expend, end)
- - -
-[docs] - def test_help_text(self): - for datestring, (single, start, end, exp_help_text) in dates.items(): - help_text = get_date_help_text_from_dates(single, start, end, datestring) - self.assertEqual(exp_help_text, help_text)
diff --git a/genindex.html b/genindex.html index b4b26a900..02f7f7690 100644 --- a/genindex.html +++ b/genindex.html @@ -1691,10 +1691,6 @@

G

  • get_data() (apis_core.generic.importers.GenericModelImporter method)
  • get_data_for_m2m_field() (apis_core.history.serializers.ModelChangeSerializer method) -
    • -
  • get_date_help_text_default() (in module apis_core.utils.DateParser) -
    • -
  • get_date_help_text_from_dates() (in module apis_core.utils.DateParser)
  • get_definition_and_attributes_from_uri() (in module apis_core.utils.rdf)
    • @@ -1720,10 +1716,10 @@

    G

  • get_entity_list_filter() (apis_core.apis_entities.models.AbstractEntity class method)
    • - - +
    @@ -2995,10 +2995,10 @@

    apis_core/utils/DateParser.py (no class) - 151 - 59 + 133 + 56 0 - 61% + 58% apis_core/utils/__init__.py @@ -3129,20 +3129,20 @@

    67% - apis_core/utils/test_DateParser.py - DateParserTest - 8 + apis_core/utils/test_DateParser.py + DateParserTest + 5 0 0 - 100% + 100% apis_core/utils/test_DateParser.py (no class) - 10 + 9 0 0 - 100% + 100% apis_core/utils/test_helpers.py @@ -3509,10 +3509,10 @@

    Total   - 4050 - 1981 + 4028 + 1978 0 - 51% + 51% @@ -3524,7 +3524,7 @@

    coverage.py v7.6.8, - created at 2024-12-17 09:35 +0000 + created at 2024-12-17 09:43 +0000