Coverage for sources/frigid/qaliases.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''' Qualified aliases to immutable data structures. 

22 

23 Provides aliases prefixed with "Immutable" for all core classes. These are 

24 useful for avoiding namespace collisions when importing from the package, 

25 particularly with common names like "Dictionary" or "Namespace". 

26 

27 For example, instead of: 

28 

29 >>> from frigid import Dictionary 

30 >>> # Possible conflict with other Dictionary classes 

31 

32 you could use: 

33 

34 >>> from frigid.qaliases import ImmutableDictionary 

35 >>> # Clearly indicates the source and behavior 

36''' 

37 

38 

39# ruff: noqa: F401 

40# pylint: disable=unused-import 

41 

42 

43from . import __ 

44from .classes import ( 

45 ABCFactory as ImmutableABCFactory, 

46 Class as ImmutableClass, 

47 ProtocolClass as ImmutableProtocolClass, 

48) 

49from .dictionaries import ( 

50 AbstractDictionary as AbstractImmutableDictionary, 

51 Dictionary as ImmutableDictionary, 

52 ValidatorDictionary as ImmutableValidatorDictionary, 

53) 

54from .modules import ( 

55 Module as ImmutableModule, 

56 reclassify_modules as reclassify_modules_as_immutable, 

57) 

58from .namespaces import ( 

59 Namespace as ImmutableNamespace, 

60) 

61from .objects import ( 

62 Object as ImmutableObject, 

63 immutable, 

64)