rename ExtractDocString (#2497)

Author: sneaxiy

cmd/sqlflow/main_test.go

@@ -593,7 +593,7 @@ LABEL class INTO sqlflow_models.my_model;`
 }
 
 func TestInputNavigation(t *testing.T) {
-	attribute.ExtractDocStringsOnce()
+	attribute.ExtractSymbolOnce()
 	a := assert.New(t)
 	s := newPromptState()
 	his1 := "history 1"
@@ -625,7 +625,7 @@ func TestInputNavigation(t *testing.T) {
 }
 
 func TestComplete(t *testing.T) {
-	attribute.ExtractDocStringsOnce()
+	attribute.ExtractSymbolOnce()
 	a := assert.New(t)
 	s := newPromptState()
 	p := prompt.NewBuffer()

doc/design/diag_attribute_error.md

@@ -90,7 +90,7 @@ For the implementation, it's easy to extract the check rule and argument documen
 ``` python
 def attribute_check(estimator, **args):
     # extract argument name, documentation and contract from doc string  
-    contract = extract_doc_string(estimator)
+    contract = extract_symbol(estimator)
     # SQLFlowDiagnosticError message can be pipe to SQLFlow GUI via SQLFlow gRPC server
     diag_err = SQLFLowDiagnosError()
     for name, value in args:

pkg/attribute/attribute.go

@@ -217,30 +217,30 @@ func NewDictionaryFromModelDefinition(estimator, prefix string) Dictionary {
 
 // PremadeModelParamsDocs stores parameters and documents of all known models
 var PremadeModelParamsDocs map[string]map[string]string
-var extractDocStringsOnce sync.Once
+var extractSymbolOnce sync.Once
 
 // OptimizerParamsDocs stores parameters and documents of optimizers
 var OptimizerParamsDocs map[string]map[string]string
 
 // XGBoostObjectiveDocs stores options for xgboost objective
 var XGBoostObjectiveDocs map[string]string
 
-// ExtractDocString extracts parameter documents of Python modules from doc strings
-func ExtractDocString(module ...string) {
+// ExtractSymbol extracts parameter documents of Python modules from doc strings
+func ExtractSymbol(module ...string) {
 	cmd := exec.Command("python", "-uc", fmt.Sprintf("__import__('symbol_extractor').print_param_doc('%s')", strings.Join(module, "', '")))
 	output, e := cmd.CombinedOutput()
 	if e != nil {
-		log.Println("ExtractDocString failed: ", e, string(output))
+		log.Println("ExtractSymbol failed: ", e, string(output))
 	}
 	// json.Unmarshal extends the map rather than reallocate a new one, see golang.org/pkg/encoding/json/#Unmarshal
 	if e := json.Unmarshal(output, &PremadeModelParamsDocs); e != nil {
-		log.Println("ExtractDocString failed:", e, string(output))
+		log.Println("ExtractSymbol failed:", e, string(output))
 	}
 }
 
-// ExtractDocStringsOnce extracts parameter documents from python doc strings using sync.Once
-func ExtractDocStringsOnce() {
-	extractDocStringsOnce.Do(func() { ExtractDocString("sqlflow_models") })
+// ExtractSymbolOnce extracts parameter documents from python doc strings using sync.Once
+func ExtractSymbolOnce() {
+	extractSymbolOnce.Do(func() { ExtractSymbol("sqlflow_models") })
 }
 
 func removeUnnecessaryParams() {

pkg/attribute/attribute_test.go

@@ -47,7 +47,7 @@ func TestParamsDocs(t *testing.T) {
 	a := assert.New(t)
 
 	a.Equal(11, len(PremadeModelParamsDocs))
-	ExtractDocStringsOnce()
+	ExtractSymbolOnce()
 	a.Equal(20, len(PremadeModelParamsDocs))
 	a.Equal(len(PremadeModelParamsDocs["DNNClassifier"]), 12)
 	a.NotContains(PremadeModelParamsDocs["DNNClassifier"], "feature_columns")

pkg/codegen/tensorflow/codegen.go

@@ -231,7 +231,7 @@ func constructLosses(trainStmt *ir.TrainStmt) {
 
 // InitializeAttributes initializes the attributes of TensorFlow and does type checking for them
 func InitializeAttributes(trainStmt *ir.TrainStmt) error {
-	attribute.ExtractDocStringsOnce()
+	attribute.ExtractSymbolOnce()
 	commonAttributes.FillDefaults(trainStmt.Attributes)
 
 	modelAttr := attribute.NewDictionaryFromModelDefinition(trainStmt.Estimator, "model.")