From 1a189692763ee16eb9594496d9b940dfffa493ae Mon Sep 17 00:00:00 2001
From: DMGithubPublisher <github@dynamsoft.com>
Date: Thu, 10 Oct 2024 16:18:57 +0800
Subject: [PATCH] update to internal commit a71bd083

---
 _config.yml                                   |  18 ++-
 _data/full_tree.yml                           |   1 +
 .../release-notes/python-highlight-2.4.10.md  |  14 +++
 _includes/sidelist-full-tree.html             |   4 +-
 .../programming-dotnet.html                   |   2 +-
 .../programming-python.html                   |  24 ++++
 assets/js/dcpServerVersionSearch.json         |  86 +++++++++++++
 index.md                                      |   4 +-
 .../api-reference/code-parser-module.md       |  41 +++++++
 programming/python/api-reference/index.md     |  22 ++++
 .../api-reference/parsed-result-item.md       | 113 ++++++++++++++++++
 .../python/api-reference/parsed-result.md     | 102 ++++++++++++++++
 programming/python/index.md                   |  18 +++
 programming/python/release-notes/index.md     |  11 ++
 programming/python/release-notes/python-2.md  |  15 +++
 15 files changed, 469 insertions(+), 6 deletions(-)
 create mode 100644 _includes/release-notes/python-highlight-2.4.10.md
 create mode 100644 _includes/sidelist-programming/programming-python.html
 create mode 100644 programming/python/api-reference/code-parser-module.md
 create mode 100644 programming/python/api-reference/index.md
 create mode 100644 programming/python/api-reference/parsed-result-item.md
 create mode 100644 programming/python/api-reference/parsed-result.md
 create mode 100644 programming/python/index.md
 create mode 100644 programming/python/release-notes/index.md
 create mode 100644 programming/python/release-notes/python-2.md

diff --git a/_config.yml b/_config.yml
index 982e2f3..cff8214 100644
--- a/_config.yml
+++ b/_config.yml
@@ -12,6 +12,10 @@ dcp_dotnet: /code-parser/docs/server/programming/dotnet/
 dcp_dotnet_api: /code-parser/docs/server/programming/dotnet/api-reference/
 dcp_dotnet_release_notes: /code-parser/docs/server/programming/dotnet/release-notes/
 
+dcp_python: /code-parser/docs/server/programming/python/
+dcp_python_api: /code-parser/docs/server/programming/python/api-reference/
+dcp_python_release_notes: /code-parser/docs/server/programming/python/release-notes/
+
 assets: /code-parser/docs/server/assets/
 edit_icon: /code-parser/docs/server/assets/img-icon/edit-icon.png
 smile_icon: /code-parser/docs/server/assets/img-icon/icon-smile.png
@@ -25,8 +29,10 @@ dcv_enumerations: /capture-vision/docs/core/enums/
 dcv_parameters: /capture-vision/docs/core/parameters/
 dcv_cpp_api: /capture-vision/docs/server/programming/cplusplus/api-reference/
 dcv_dotnet_api: /capture-vision/docs/server/programming/dotnet/api-reference/
+dcv_python_api: /capture-vision/docs/server/programming/python/api-reference/
 
-useVersionTree: true
+useVersionTree: false
+isDCV: true
 
 baseurl: "/code-parser/docs/server"
 plugins:
@@ -53,6 +59,16 @@ defaults:
     values: 
       docRootName: "Code Parser C++ Edition" 
       docHomePage: "/code-parser/docs/server/programming/cplusplus/"
+  - scope: 
+      path: "programming/dotnet" 
+    values: 
+      docRootName: "Code Parser .NET Edition" 
+      docHomePage: "/code-parser/docs/server/programming/dotnet/"
+  - scope: 
+      path: "programming/python" 
+    values: 
+      docRootName: "Code Parser Python Edition" 
+      docHomePage: "/code-parser/docs/server/programming/python/"
   - scope:
       path: "Hide_Tree_Page.html"
     values:
diff --git a/_data/full_tree.yml b/_data/full_tree.yml
index 37adf02..60a960c 100644
--- a/_data/full_tree.yml
+++ b/_data/full_tree.yml
@@ -2,3 +2,4 @@ tree_file_list:
     - sidelist-full-tree.html
     - sidelist-programming/programming-cpp.html
     - sidelist-programming/programming-dotnet.html
+    - sidelist-programming/programming-python.html
diff --git a/_includes/release-notes/python-highlight-2.4.10.md b/_includes/release-notes/python-highlight-2.4.10.md
new file mode 100644
index 0000000..4f32af6
--- /dev/null
+++ b/_includes/release-notes/python-highlight-2.4.10.md
@@ -0,0 +1,14 @@
+
+* This is the first release of the Python Edition of `DynamsoftCodeParser` SDK integrated with `DynamsoftCaptureVision (DCV)` architecture, which is newly established to aggregate the features of functional products powered by Dynamsoft. The features are designed to be pluggable, customizable and interactable. In addition, the functional products share the computation so that their processing speed is much higher than working individually.
+* Added supports to parse following code types:
+  * [MRTD_TD1_ID]({{ site.dcp_code_types }}mrtd.html)
+  * [MRTD_TD2_ID]({{ site.dcp_code_types }}mrtd.html)
+  * [MRTD_TD2_VISA]({{ site.dcp_code_types }}mrtd.html)
+  * [MRTD_TD3_PASSPORT]({{ site.dcp_code_types }}mrtd.html)
+  * [MRTD_TD3_VISA]({{ site.dcp_code_types }}mrtd.html)
+  * [VIN]({{ site.dcp_code_types }}vin.html)
+  * [AAMVA_DL_ID]({{ site.dcp_code_types }}aamva-dl-id.html)
+  * [AAMVA_DL_ID_WITH_MAG_STRIPE]({{ site.dcp_code_types }}aamva-dl-id.html)
+  * [AADHAAR]({{ site.dcp_code_types }}aadhaar.html)
+  * [SOUTH_AFRICA_DL]({{ site.dcp_code_types }}za-dl.html)
+
diff --git a/_includes/sidelist-full-tree.html b/_includes/sidelist-full-tree.html
index 4b74f75..3270a2e 100644
--- a/_includes/sidelist-full-tree.html
+++ b/_includes/sidelist-full-tree.html
@@ -1,8 +1,8 @@
-<!--
 <li lang="python">
-    <a href="{{ site.python }}" class="otherLinkColour">Python Edition Introduction</a>
+    <a href="{{ site.dcp_python }}" class="otherLinkColour">Python Edition Introduction</a>
 </li>
 {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-python.html" -%}
+<!--
 <li lang="java">
     <a href="{{ site.java }}" class="otherLinkColour">Java Edition Introduction</a>
 </li>
diff --git a/_includes/sidelist-programming/programming-dotnet.html b/_includes/sidelist-programming/programming-dotnet.html
index 848bf2d..9a65751 100644
--- a/_includes/sidelist-programming/programming-dotnet.html
+++ b/_includes/sidelist-programming/programming-dotnet.html
@@ -1,5 +1,5 @@
 <li lang="dotnet" class="category">DEVELOPMENT</li>
-<li lang="dotnet"><a class="otherLinkColour">API Reference</a>
+<li lang="dotnet"><a href="{{ site.dcp_dotnet_api }}" class="otherLinkColour">API Reference</a>
     <ul>
         <li><a class="otherLinkColour">Classes</a>
             <ul>
diff --git a/_includes/sidelist-programming/programming-python.html b/_includes/sidelist-programming/programming-python.html
new file mode 100644
index 0000000..04c2ecb
--- /dev/null
+++ b/_includes/sidelist-programming/programming-python.html
@@ -0,0 +1,24 @@
+<li lang="python" class="category">DEVELOPMENT</li>
+<li lang="python"><a href="{{ site.dcp_python_api }}" class="otherLinkColour">API Reference</a>
+    <ul>
+        <li><a class="otherLinkColour">Classes</a>
+            <ul>
+                <li><a href="{{ site.dcp_python_api }}code-parser-module.html"  class="otherLinkColour">CodeParserModule</a></li>
+                <li><a href="{{ site.dcp_python_api }}parsed-result.html"  class="otherLinkColour">ParsedResult</a></li>
+                <li><a href="{{ site.dcp_python_api }}parsed-result-item.html"  class="otherLinkColour">ParsedResultItem</a></li>
+            </ul>
+        </li>
+        <li><a class="otherLinkColour">Enumerations</a>
+            <ul>
+                <li><a href="{{ site.dcv_enumerations }}core/error-code.html?lang=python"  class="otherLinkColour">EnumErrorCode</a></li>
+                <li><a href="{{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=python"  class="otherLinkColour">EnumMappingStatus</a></li>
+                <li><a href="{{ site.dcv_enumerations }}code-parser/validation-status.html?lang=python"  class="otherLinkColour">EnumValidationStatus</a></li>
+            </ul>
+        </li>
+    </ul>
+</li>
+<li lang="python"><a href="{{ site.dcp_python_release_notes }}" class="otherLinkColour">Release Notes</a>
+    <ul >
+        <li ><a href="{{ site.dcp_python_release_notes }}python-2.html" class="otherLinkColour">Version 2.x</a></li>
+    </ul>
+</li>
diff --git a/assets/js/dcpServerVersionSearch.json b/assets/js/dcpServerVersionSearch.json
index 2263a7b..04ed6ad 100644
--- a/assets/js/dcpServerVersionSearch.json
+++ b/assets/js/dcpServerVersionSearch.json
@@ -87,6 +87,92 @@
                         "version": "3.4.10"
                     }
                 ]
+            },
+            "python":{
+                "dcvRepoServer": [
+                    {
+                        "path": "/programming/python/api-reference/capture-vision-router",
+                        "version": "2.4.10"
+                    },
+                    {
+                        "path": "/programming/python/api-reference/core",
+                        "version": "3.2.40"
+                    },
+                    {
+                        "path": "/programming/python/api-reference/image-processing",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/programming/python/api-reference/license",
+                        "version": "3.2.30"
+                    },
+                    {
+                        "path": "/programming/python/api-reference/utility",
+                        "version": "1.4.10"
+                    }
+                ],
+                "dcvRepoCore": [
+                    {
+                        "path": "/enums/capture-vision-router",
+                        "version": "2.4.10"
+                    },
+                    {
+                        "path": "/enums/code-parser",
+                        "version": "2.4.10"
+                    },
+                    {
+                        "path": "/enums/core",
+                        "version": "3.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/barcode-format-specification",
+                        "version": "10.4.10"
+                    },
+                    {
+                        "path": "/parameters/reference/barcode-reader-task-settings",
+                        "version": "10.4.10"
+                    },
+                    {
+                        "path": "/parameters/reference/capture-vision-template",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/character-model",
+                        "version": "3.4.10"
+                    },
+                    {
+                        "path": "/parameters/reference/code-parser-task-settings",
+                        "version": "2.4.10"
+                    },
+                    {
+                        "path": "/parameters/reference/global-parameter",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/image-parameter",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/image-source-options",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/label-recognizer-task-settings",
+                        "version": "3.4.10"
+                    },
+                    {
+                        "path": "/parameters/reference/semantic-processing",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/target-roi-def",
+                        "version": "2.2.40"
+                    },
+                    {
+                        "path": "/parameters/reference/text-line-specification",
+                        "version": "3.4.10"
+                    }
+                ]
             }
         }
     },
diff --git a/index.md b/index.md
index da049de..3ea22e3 100644
--- a/index.md
+++ b/index.md
@@ -1,7 +1,7 @@
 ---
 layout: home-page
 title: Dynamsoft Code Parser SDK Documentation
-keywords: Dynamsoft Code Parser, dlr, documentation
+keywords: Dynamsoft Code Parser, documentation
 description: Dynamsoft Code Parser SDK Documentation Homepage
 ---
 
@@ -11,9 +11,9 @@ Learn how to use Dynamsoft Code Parser SDK in different programming languages:
 
 - [C++]({{ site.dcp_cpp }})
 - [.NET]({{ site.dcp_dotnet }})
+- [Python]({{ site.dcp_python }})
 
 Coming soon:
 
-- Python
 - C
 - Java
diff --git a/programming/python/api-reference/code-parser-module.md b/programming/python/api-reference/code-parser-module.md
new file mode 100644
index 0000000..7825198
--- /dev/null
+++ b/programming/python/api-reference/code-parser-module.md
@@ -0,0 +1,41 @@
+---
+layout: default-layout
+title: CodeParserModule Class - Dynamsoft Code Parser Module Python Edition API Reference
+description: Definition of the CodeParserModule class in Dynamsoft Code Parser Module Python Edition.
+keywords: CodeParserModule, api reference, python
+needAutoGenerateSidebar: true
+---
+
+# CodeParserModule Class
+
+The `CodeParserModule` class defines general functions in the code parser module.
+
+## Definition
+
+*Module:* dynamsoft_code_parser
+
+
+```python
+class CodeParserModule(object)
+```
+
+## Methods
+
+| Method               | Description |
+|----------------------|-------------|
+| [`get_version`](#get_version) | Returns the version of the code parser module.|
+
+
+### get_version
+
+Returns the version of the code parser module.
+
+```python
+@staticmethod
+def get_version() -> str:
+```
+
+**Return Value**
+
+Returns a string representing the version of the code parser module.
+
diff --git a/programming/python/api-reference/index.md b/programming/python/api-reference/index.md
new file mode 100644
index 0000000..ebfbfbf
--- /dev/null
+++ b/programming/python/api-reference/index.md
@@ -0,0 +1,22 @@
+---
+layout: default-layout
+title: Main Page - Dynamsoft Code Parser Module Python Edition API Reference
+description: This is the main page of Dynamsoft Code Parser SDK Python Edition API Reference.
+keywords: api reference, python
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+---
+
+# API Reference - Dynamsoft Code Parser SDK Python Edition
+
+## Classes
+
+* [`CodeParserModule`]({{ site.dcp_python_api }}code-parser-module.html)
+* [`ParsedResult`]({{ site.dcp_python_api }}parsed-result.html)
+* [`ParsedResultItem`]({{ site.dcp_python_api }}parsed-result-item.html)
+
+## Enumerations  
+
+* [`EnumErrorCode`]({{ site.dcv_enumerations }}core/error-code.html?lang=python)
+* [`EnumMappingStatus`]({{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=python)
+* [`EnumValiadtionStatus`]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=python)
diff --git a/programming/python/api-reference/parsed-result-item.md b/programming/python/api-reference/parsed-result-item.md
new file mode 100644
index 0000000..e86aba3
--- /dev/null
+++ b/programming/python/api-reference/parsed-result-item.md
@@ -0,0 +1,113 @@
+---
+layout: default-layout
+title: ParsedResultItem Class - Dynamsoft Code Parser Module Python Edition API Reference
+description: Definition of the ParsedResultItem class in Dynamsoft Code Parser Module Python Edition.
+keywords: ParsedResultItem, api reference, python
+needAutoGenerateSidebar: true
+---
+
+# ParsedResultItem Class
+
+The `ParsedResultItem` class represents a parsed result item generated by code parser engine.
+
+## Definition
+
+*Module:* dynamsoft_code_parser
+
+*Inheritance:* [CapturedResultItem]({{ site.dcv_python_api }}core/basic-classes/captured-result-item.html) -> ParsedResultItem
+
+```python
+class ParsedResultItem(dynamsoft_core.CapturedResultItem)
+```
+
+## Methods
+
+| Method               | Description |
+|----------------------|-------------|
+| [`get_code_type`](#get_code_type) | Gets the code type of the parsed result. |
+| [`get_field_value`](#get_field_value) | Gets the value of a specified field from the parsed result. |
+| [`get_field_mapping_status`](#get_field_mapping_status) | Gets the mapping status of a specified field from the parsed result. |
+| [`get_field_validation_status`](#get_field_validation_status) | Gets the validation status of a specified field from the parsed result. |
+| [`get_json_string`](#get_json_string) | Gets the parsed result as a JSON formatted string. |
+  
+### get_code_type
+
+Gets the code type of the parsed result.
+
+```python
+def get_code_type(self) -> str:
+```
+
+**Return Value**
+
+Returns a string value representing the code type.
+
+### get_field_value
+
+Gets the value of a specified field from the parsed result.
+
+```python
+def get_field_value(self, field_name: str) -> str:
+```
+
+**Parameters**
+
+`field_name` The name of the field.
+
+**Return Value**
+
+Returns a string representing the specified field value.
+
+### get_field_mapping_status
+
+Gets the mapping status of a specified field from the parsed result.
+
+```python
+def get_field_mapping_status(self, field_name: str) -> int:
+```
+
+**Parameters**
+
+`field_name` The name of the field.
+
+
+**Return Value**
+
+Returns an `EnumMappingStatus` value representing the mapping status of a specified field.
+
+**See Also**
+
+[EnumMappingStatus]({{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=python)
+
+### get_field_validation_status
+
+Gets the validation status of a specified field from the parsed result.
+
+```python
+def get_field_validation_status(self, field_name: str) -> int:
+```
+
+**Parameters**
+
+`field_name` The name of the field.
+
+**Return Value**
+
+Returns an `EnumValidationStatus` value representing the validation status of a specified field.
+
+**See Also**
+
+[EnumValidationStatus]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=python)
+
+### get_json_string
+
+Gets the parsed result as a JSON formatted string.
+
+```python
+def get_json_string(self) -> str:
+```
+
+**Return Value**
+
+Returns a JSON formatted string representing the full parsed result.
+
diff --git a/programming/python/api-reference/parsed-result.md b/programming/python/api-reference/parsed-result.md
new file mode 100644
index 0000000..32d8379
--- /dev/null
+++ b/programming/python/api-reference/parsed-result.md
@@ -0,0 +1,102 @@
+---
+layout: default-layout
+title: ParsedResult Class - Dynamsoft Code Parser Module Python Edition API Reference
+description: Definition of the ParsedResult class in Dynamsoft Code Parser Module Python Edition.
+keywords: ParsedResult, api reference, python
+needAutoGenerateSidebar: true
+---
+
+# ParsedResult Class
+
+The `ParsedResult` class represents the results of a code parser process.
+
+## Definition
+
+*Module:* dynamsoft_code_parser
+
+```python
+class ParsedResult(object)
+```
+
+## Methods
+
+| Method               | Description |
+|----------------------|-------------|
+| [`get_original_image_hash_id`](#get_original_image_hash_id) | Gets the hash ID of the source image. |
+| [`get_original_image_tag`](#get_original_image_tag) | Gets the tag of the source image. |
+| [`get_items`](#get_items) | Gets all the parsed result items. |
+| [`get_error_code`](#get_error_code) | Gets the error code of the parsed result, if an error occurred. |
+| [`get_error_string`](#get_error_string) | Gets the error message of the parsed result, if an error occurred. |
+
+### get_original_image_hash_id
+
+Gets the hash ID of the source image.
+
+```python
+def get_original_image_hash_id(self) -> str:
+```
+
+**Return Value**
+
+Returns a string containing the hash ID of the source image.
+
+### get_original_image_tag
+
+Gets the tag of the source image.
+
+```python
+def get_original_image_tag(self) -> ImageTag:
+```
+
+**Return Value**
+
+Returns an `ImageTag` object representing the tag of the source image.
+
+**See Also**
+
+[ImageTag]({{ site.dcv_python_api }}core/basic-classes/image-tag.html)
+
+### get_items
+
+Gets all the parsed result items.
+
+```python
+def get_items(self) -> List[ParsedResultItem]:
+```
+
+**Return Value**
+
+Returns a `ParsedResultItem` list.
+
+**See Also**
+
+[ParsedResultItem]({{ site.dcp_python_api }}parsed-result-item.html)
+
+### get_error_code
+
+Gets the error code of the parsed result, if an error occurred.
+
+```python
+def get_error_code(self) -> int:
+```
+
+**Return Value**
+
+Returns the error code of the parsed result, or 0 if no error occurred.
+
+**See Also**
+
+[EnumErrorCode]({{ site.dcv_enumerations }}core/error-code.html?lang=python)
+
+### get_error_string
+
+Gets the error message of the parsed result, if an error occurred.
+
+```python
+def get_error_string(self) -> str:
+```
+
+**Return Value**
+
+Returns a string containing the error message of the parsed result, or an empty string if no error occurred.
+
diff --git a/programming/python/index.md b/programming/python/index.md
new file mode 100644
index 0000000..8e6a047
--- /dev/null
+++ b/programming/python/index.md
@@ -0,0 +1,18 @@
+---
+layout: default-layout
+title: Main Page - Dynamsoft Code Parser SDK Python Edition
+description: This is the main page of Dynamsoft Code Parser SDK Python Edition.
+keywords: python
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+---
+
+# Dynamsoft Code Parser Python Edition Documentation
+
+## API Reference
+
+- [API Reference](api-reference/index.md)
+
+## Release Notes
+
+- [Version 2.x](release-notes/python-2.md)
diff --git a/programming/python/release-notes/index.md b/programming/python/release-notes/index.md
new file mode 100644
index 0000000..416a0a5
--- /dev/null
+++ b/programming/python/release-notes/index.md
@@ -0,0 +1,11 @@
+---
+layout: default-layout
+title: Release Notes - Dynamsoft Code Parser SDK Python Edition
+description: This is the release notes page of Dynamsoft Code Parser SDK Python Edition.
+keywords: release notes, python
+needAutoGenerateSidebar: false
+---
+
+# Release Notes - Python Edition
+
+- [2.4.10 (08/27/2024)](python-2.md#2410-08272024)
diff --git a/programming/python/release-notes/python-2.md b/programming/python/release-notes/python-2.md
new file mode 100644
index 0000000..d95e086
--- /dev/null
+++ b/programming/python/release-notes/python-2.md
@@ -0,0 +1,15 @@
+---
+layout: default-layout
+title: Release Notes v2.x - Dynamsoft Code Parser SDK Python Edition
+description: This is the release notes page of Dynamsoft Code Parser SDK Python Edition v2.x.
+keywords: release notes, python
+needGenerateH3Content: false
+---
+
+# Release Notes for Python Edition - 2.x
+
+## 2.4.10 (08/27/2024)
+
+### Highlights
+
+{%- include release-notes/python-highlight-2.4.10.md -%}