Coverage for sources/dynadoc/__init__.py: 100%

1# vim: set filetype=python fileencoding=utf-8: 

2# -*- coding: utf-8 -*- 

3 

4#============================================================================# 

5# # 

6# Licensed under the Apache License, Version 2.0 (the "License"); # 

7# you may not use this file except in compliance with the License. # 

8# You may obtain a copy of the License at # 

9# # 

10# http://www.apache.org/licenses/LICENSE-2.0 # 

11# # 

12# Unless required by applicable law or agreed to in writing, software # 

13# distributed under the License is distributed on an "AS IS" BASIS, # 

14# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # 

15# See the License for the specific language governing permissions and # 

16# limitations under the License. # 

17# # 

18#============================================================================# 

19 

20 

21''' Docstring generation from annotations with configurable output formats. ''' 

22 

23 

24from . import __ 

25from . import assembly 

26from . import context 

27from . import factories 

28from . import interfaces 

29from . import introspection 

30from . import nomina 

31from . import renderers 

32from . import xtnsapi 

33# --- BEGIN: Injected by Copier --- 

34# --- END: Injected by Copier --- 

35 

36from .userapi import * 

37 

38 

39__version__: __.typx.Annotated[ str, Visibilities.Reveal ] 

40__version__ = '1.2.1' 

41 

42 

43def _notify( level: NotificationLevels, message: str ) -> None: 

44 ''' Issues warning message. (Internal use within this package itself.) ''' 

45 __.warnings.warn( # pyright: ignore[reportCallIssue] 

46 message, category = RuntimeWarning, stacklevel = 2 ) 

47 

48 

49_context = produce_context( notifier = _notify ) 

50_introspection_cc = ClassIntrospectionControl( 

51 inheritance = True, 

52 introspectors = ( introspection.introspect_special_classes, ) ) 

53_introspection = IntrospectionControl( 

54 class_control = _introspection_cc, targets = IntrospectionTargetsOmni ) 

55assign_module_docstring( 

56 __.package_name, 

57 context = _context, 

58 introspection = _introspection, 

59 table = __.fragments ) 

60# TODO: Reclassify package modules as immutable and concealed.