Coverage for sources/frigid/installers.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''' Convenience to expose certain package features as Python builtins. ''' 

22 

23 

24from __future__ import annotations 

25 

26from . import __ 

27 

28 

29def install( 

30 single_name: __.typx.Annotated[ 

31 str | None, 

32 __.typx.Doc( 

33 'Name to use for single function in builtins. ``None`` to skip.' ) 

34 ] = 'one', 

35) -> None: 

36 ''' Installs 1-element tuple constructor into builtins. 

37 

38 Example 

39 ------- 

40 >>> install( ) # Installs as 'one' 

41 >>> one( 42 ) # Now available in builtins 

42 (42,) 

43 >>> install( single_name = 'single' ) # Install with custom name 

44 >>> single( 42 ) 

45 (42,) 

46 ''' 

47 builtins = __import__( 'builtins' ) 

48 if single_name: 

49 from .sequences import one 

50 setattr( builtins, single_name, one )