[FIX] tools: Improve docstring of load_xsd_files_from_url()

This is to clarify that the file_name param is not used if a ZIP is
downloaded: in that case, the filenames in the ZIP are used to save
the attachment.

See discussion in https://github.com/odoo/odoo/pull/115720#pullrequestreview-1392562860

closes odoo/odoo#124946

X-original-commit: ae94f14a844352f66490ec326fe2d1a716023891
Signed-off-by: Josse Colpaert <jco@odoo.com>
Signed-off-by: Antoine Dupuis (andu) <andu@odoo.com>
This commit is contained in:
Antoine Dupuis (andu)
2023-06-14 10:54:47 +02:00
parent 059841d870
commit c31beb459d
+4 -3
View File
@@ -156,8 +156,9 @@ def load_xsd_files_from_url(env, url, file_name=None, force_reload=False,
request_max_timeout=10, xsd_name_prefix='', xsd_names_filter=None, modify_xsd_content=None):
"""Load XSD file or ZIP archive. Save XSD files as ir.attachment.
An XSD attachment from the database is identified by its prefixed `file_name`. A typical prefix is the
calling module name.
An XSD attachment is saved as {xsd_name_prefix}.{filename} where the filename is either the filename obtained
from the URL or from the ZIP archive, or the `file_name` param if it is specified and a single XSD is being downloaded.
A typical prefix is the calling module's name.
For ZIP archives, XSD files inside it will be saved as attachments, depending on the provided list of XSD names.
ZIP archive themselves are not saved.
@@ -168,7 +169,7 @@ def load_xsd_files_from_url(env, url, file_name=None, force_reload=False,
:param odoo.api.Environment env: environment of calling module
:param str url: URL of XSD file/ZIP archive
:param str file_name: the name given to the XSD attachment
:param str file_name: used as attachment name if the URL leads to a single XSD, otherwise ignored
:param bool force_reload: Deprecated.
:param int request_max_timeout: maximum time (in seconds) before the request times out
:param str xsd_name_prefix: if provided, will be added as a prefix to every XSD file name