24#ifndef PXR_BASE_TF_PY_ARG_H
25#define PXR_BASE_TF_PY_ARG_H
28#include "pxr/base/tf/api.h"
30#include <boost/python/dict.hpp>
31#include <boost/python/tuple.hpp>
35PXR_NAMESPACE_OPEN_SCOPE
50 const std::string& typeDoc = std::string(),
51 const std::string& defaultValueDoc = std::string())
52 : _name(name), _typeDoc(typeDoc), _defaultValueDoc(defaultValueDoc)
61 {
return _defaultValueDoc; }
70 std::string _defaultValueDoc;
73typedef std::vector<TfPyArg> TfPyArgs;
87std::pair<boost::python::tuple, boost::python::dict>
88TfPyProcessOptionalArgs(
89 const boost::python::tuple& args,
90 const boost::python::dict& kwargs,
91 const TfPyArgs& expectedArgs,
92 bool allowExtraArgs =
false);
98std::string TfPyCreateFunctionDocString(
99 const std::string& functionName,
100 const TfPyArgs& requiredArguments = TfPyArgs(),
101 const TfPyArgs& optionalArguments = TfPyArgs(),
102 const std::string& description = std::string());
104PXR_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.