Skip to content

Refactor - Allow passing extra package name to check dependency #2577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/partial-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ jobs:
mypy_flags: "--ignore-missing-imports --implicit-optional --disable-error-code attr-defined --no-namespace-packages --exclude (taipy/templates/|tools/|doc/gui/examples/.*/builder.py|taipy/common/config/config.pyi) --follow-imports skip --disable-error-code import-untyped"

- uses: chartboost/ruff-action@v1
with:
src: './taipy ./tests'
tests:
needs: linter
timeout-minutes: 50
Expand Down
29 changes: 18 additions & 11 deletions taipy/core/common/_check_dependencies.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,33 @@
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.

from importlib import util
from typing import Optional


def _check_dependency_is_installed(module_name: str, package_name: str) -> None:
def _check_dependency_is_installed(
module_name: str, package_name: str, extra_taipy_package_name: str, taipy_sublibrary: Optional[str] = None
) -> None:
"""
Check if a package is installed.
Check if an extra package for taipy is installed.

Args:
module_name: Name of the taipy module importing the package.
package_name: Name of the package.
extra_taipy_package_name: Name of the extra taipy package.
taipy_sublibrary: Optional name of the taipy sublibrary.

Args:
module_name: Name of the taipy module importing the package.
package_name: Name of the package.
.
Raises:
RuntimeError: If the package is not installed.
"""
extras = {
"boto3": "s3",
"pymongo": "mongo",
}
if taipy_sublibrary is None:
taipy_sublibrary = "taipy"

if not util.find_spec(package_name):
raise RuntimeError(
f"Cannot use {module_name} as {package_name} package is not installed. Please install it "
f"using `pip install taipy[{extras.get(package_name)}]`."
f"using `pip install {taipy_sublibrary}[{extra_taipy_package_name}]`."
)


Expand Down
3 changes: 1 addition & 2 deletions taipy/core/data/aws_s3.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ class S3ObjectDataNode(DataNode):
__AWS_S3_GET_OBJECT_PARAMETERS = "aws_s3_get_object_parameters"
__AWS_S3_PUT_OBJECT_PARAMETERS = "aws_s3_put_object_parameters"


_REQUIRED_PROPERTIES: List[str] = [
__AWS_ACCESS_KEY_ID,
__AWS_SECRET_ACCESS_KEY,
Expand All @@ -93,7 +92,7 @@ def __init__(
editor_expiration_date: Optional[datetime] = None,
properties: Optional[Dict] = None,
) -> None:
_check_dependency_is_installed("S3 Data Node", "boto3")
_check_dependency_is_installed("S3 Data Node", "boto3", "s3")
if properties is None:
properties = {}
required = self._REQUIRED_PROPERTIES
Expand Down
3 changes: 1 addition & 2 deletions taipy/core/data/mongo.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ def __init__(
editor_expiration_date: Optional[datetime] = None,
properties: Dict = None,
) -> None:
_check_dependency_is_installed("Mongo Data Node", "pymongo")
_check_dependency_is_installed("Mongo Data Node", "pymongo", "mongo")
if properties is None:
properties = {}
required = self._REQUIRED_PROPERTIES
Expand Down Expand Up @@ -269,4 +269,3 @@ def _default_encoder(self, document_object: Any) -> Dict:
The document dictionary.
"""
return document_object.__dict__

Loading