print default value in FunctionSignature (#127059)

huihoaan · pytorchmergebot · commit c9172d4471a8 · 2024-05-28T18:04:31.000Z
Fixes #[126758](#126758) and #[126759](#126759) The output information in the issue is not accurate because `FunctionSignature::toString()` print the schema strings without default. https://github.com/pytorch/pytorch/blob/cb6ef68caa22c1a2f7a4e8583c0e7c923c8bfd17/torch/csrc/utils/python_arg_parser.cpp#L1282-L1283 This pr, by adding a `default_value` to save the default str ,which shoule be priented. Of course, can also add an new api to reverse `default_bool/default_int` to string, which is slightly more complicated. result: ![image](https://github.com/pytorch/pytorch/assets/37650440/f58a4cbf-b0f4-4c81-9106-59f0d35c54ea) Pull Request resolved: #127059 Approved by: https://github.com/janeyx99
diff --git a/torch/csrc/utils/python_arg_parser.cpp b/torch/csrc/utils/python_arg_parser.cpp
@@ -1207,6 +1207,7 @@ void FunctionParameter::set_default_str(const std::string& str) {
   } else {
     throw std::runtime_error("unknown parameter type");
   }
+  default_value = str;
 }
 
 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-member-init)
@@ -1280,7 +1281,6 @@ FunctionSignature::FunctionSignature(const std::string& fmt, int index)
 }
 
 std::string FunctionSignature::toString() const {
-  // TODO: consider printing more proper schema strings with defaults,
   // optionals, etc.
   std::ostringstream ss;
   bool keyword_already = false;
@@ -1295,6 +1295,9 @@ std::string FunctionSignature::toString() const {
       keyword_already = true;
     }
     ss << param.type_name() << " " << param.name;
+    if (param.optional) {
+      ss << " = " << param.default_value;
+    }
     i++;
   }
   ss << ")";
diff --git a/torch/csrc/utils/python_arg_parser.h b/torch/csrc/utils/python_arg_parser.h
@@ -347,6 +347,7 @@ struct FunctionParameter {
     at::ScalarType default_scalartype;
     at::Layout default_layout;
   };
+  std::string default_value;
 };
 
 template <int N>

Original file line number	Diff line number	Diff line change
`@@ -1207,6 +1207,7 @@ void FunctionParameter::set_default_str(const std::string& str) {`
`1207`	`1207`	`} else {`
`1208`	`1208`	`throw std::runtime_error("unknown parameter type");`
`1209`	`1209`	`}`
	`1210`	`+ default_value = str;`
`1210`	`1211`	`}`
`1211`	`1212`
`1212`	`1213`	`// NOLINTNEXTLINE(cppcoreguidelines-pro-type-member-init)`
`@@ -1280,7 +1281,6 @@ FunctionSignature::FunctionSignature(const std::string& fmt, int index)`
`1280`	`1281`	`}`
`1281`	`1282`
`1282`	`1283`	`std::string FunctionSignature::toString() const {`
`1283`		`- // TODO: consider printing more proper schema strings with defaults,`
`1284`	`1284`	`// optionals, etc.`
`1285`	`1285`	`std::ostringstream ss;`
`1286`	`1286`	`bool keyword_already = false;`
`@@ -1295,6 +1295,9 @@ std::string FunctionSignature::toString() const {`
`1295`	`1295`	`keyword_already = true;`
`1296`	`1296`	`}`
`1297`	`1297`	`ss << param.type_name() << " " << param.name;`
	`1298`	`+ if (param.optional) {`
	`1299`	`+ ss << " = " << param.default_value;`
	`1300`	`+ }`
`1298`	`1301`	`i++;`
`1299`	`1302`	`}`
`1300`	`1303`	`ss << ")";`