FilesExpand file tree

master

/

BuiltinPythonModule.cs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

95 lines (84 loc) · 4.07 KB

master

/

BuiltinPythonModule.cs

Copy path

Top

File metadata and controls

• Code
• Blame

95 lines (84 loc) · 4.07 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

/* ****************************************************************************

*

* Copyright (c) Microsoft Corporation.

*

* This source code is subject to terms and conditions of the Apache License, Version 2.0. A

* copy of the license can be found in the License.html file at the root of this distribution. If

* you cannot locate the Apache License, Version 2.0, please send an email to

* dlr@microsoft.com. By using this source code in any fashion, you are agreeing to be bound

* by the terms of the Apache License, Version 2.0.

*

* You must not remove this notice, or any other, from this software.

*

*

* ***************************************************************************/

using System;

using System.Collections.Generic;

using IronPython.Compiler;

using Microsoft.Scripting.Utils;

namespace IronPython.Runtime {

/// <summary>

/// Implements a built-in module which is instanced per PythonContext.

///

/// Implementers can subclass this type and then have a module which has efficient access

/// to internal state (this doesn't need to go through PythonContext.GetModuleState). These

/// modules can also declare module level globals which they'd like to provide efficient

/// access to by overloading GetGlobalVariableNames. When Initialize is called these

/// globals are provided and can be cached in the instance for fast global access.

///

/// Just like normal static modules these modules are registered with the PythonModuleAttribute.

/// </summary>

public class BuiltinPythonModule {

private readonly PythonContext/*!*/ _context;

private CodeContext/*!*/ _codeContext;

protected BuiltinPythonModule(PythonContext/*!*/ context) {

ContractUtils.RequiresNotNull(context, "context");

_context = context;

}

/// <summary>

/// Initializes the module for it's first usage. By default this calls PerformModuleReload with the

/// the dictionary.

/// </summary>

/// <param name="codeContext">The CodeContext for the module.</param>

/// <param name="optimizedGlobals">A list of globals which have optimize access. Contains at least all of the global variables reutrned by GetGlobalVariableNames.</param>

protected internal virtual void Initialize(CodeContext/*!*/ codeContext, Dictionary<string/*!*/, PythonGlobal/*!*/>/*!*/ optimizedGlobals) {

ContractUtils.RequiresNotNull(codeContext, "codeContext");

ContractUtils.RequiresNotNull(optimizedGlobals, "globals");

_codeContext = codeContext;

PerformModuleReload();

}

/// <summary>

/// Gets a list of variable names which should have optimized storage (instances of PythonGlobal objects).

/// The module receives the global objects during the Initialize call and can hold onto them for

/// direct access to global members.

/// </summary>

protected internal virtual IEnumerable<string/*!*/>/*!*/ GetGlobalVariableNames() {

return ArrayUtils.EmptyStrings;

}

/// <summary>

/// Called when the user attempts to reload() on your module and by the base class Initialize method.

///

/// This provides an opportunity to allocate any per-module data which is not simply function definitions.

///

/// A common usage here is to create exception objects which are allocated by the module using PythonExceptions.CreateSubType.

/// </summary>

protected internal virtual void PerformModuleReload() {

}

/// <summary>

/// Provides access to the PythonContext which this module was created for.

/// </summary>

protected PythonContext/*!*/ Context {

get {

return _context;

}

}

/// <summary>

/// Provides access to the CodeContext for the module. Returns null before Initialize() is called.

/// </summary>

protected CodeContext Globals {

get {

return _codeContext;

}

}

}

}