7#ifndef PXR_BASE_TF_PY_ARG_H
8#define PXR_BASE_TF_PY_ARG_H
11#include "pxr/base/tf/api.h"
13#include "pxr/external/boost/python/dict.hpp"
14#include "pxr/external/boost/python/tuple.hpp"
18PXR_NAMESPACE_OPEN_SCOPE
33 const std::string& typeDoc = std::string(),
34 const std::string& defaultValueDoc = std::string())
35 : _name(name), _typeDoc(typeDoc), _defaultValueDoc(defaultValueDoc)
44 {
return _defaultValueDoc; }
53 std::string _defaultValueDoc;
56typedef std::vector<TfPyArg> TfPyArgs;
70std::pair<pxr_boost::python::tuple, pxr_boost::python::dict>
71TfPyProcessOptionalArgs(
72 const pxr_boost::python::tuple& args,
73 const pxr_boost::python::dict& kwargs,
74 const TfPyArgs& expectedArgs,
75 bool allowExtraArgs =
false);
81std::string TfPyCreateFunctionDocString(
82 const std::string& functionName,
83 const TfPyArgs& requiredArguments = TfPyArgs(),
84 const TfPyArgs& optionalArguments = TfPyArgs(),
85 const std::string& description = std::string());
87PXR_NAMESPACE_CLOSE_SCOPE
Class representing a function argument.
const std::string & GetName() const
Returns argument name.
TfPyArg(const std::string &name, const std::string &typeDoc=std::string(), const std::string &defaultValueDoc=std::string())
Create a TfPyArg representing an argument with the given name.
const std::string & GetTypeDoc() const
Returns documentation of type of value required by this argument.
const std::string & GetDefaultValueDoc() const
Returns documentation for default value (if any) for this argument.