climatology/clim/util/introspect.py

# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#!/bin/env python

"""
introspect.py -- A few introspection utilities, most importantly myArgs().
"""

import sys, os
from inspect import currentframe, getargvalues, getmodule


def callingFrame():
    """Return calling frame info."""
    return currentframe().f_back

def myArgs():
    """Return the arguments of the executing function (the caller of myArgs)."""
    return getargvalues(currentframe().f_back)[3]


def test():
    def func1(a, b, c):
        print(currentframe())
        print(getmodule(callingFrame()))   # getmodule doesn't work on frame objects
        args = myArgs()
        print(args)
        return a + b + c

    return func1(1, 2, 3)


def main(args):
    print(test())

if __name__ == '__main__':
    main(sys.argv[1:])