### ===================================================================================================================
### File handling functions
### ===================================================================================================================
# Copyright ©VIIA 2025
### ===================================================================================================================
### 1. Import modules
### ===================================================================================================================
# General imports
from __future__ import annotations
from typing import TYPE_CHECKING
from pathlib import Path
from typing import Optional
# References for functions and classes in the rhdhv_fem package
from rhdhv_fem.tools.fem_get_file import fem_get_file
# References for functions and classes in the viiaPackage
if TYPE_CHECKING:
from viiapackage.viiaStatus import ViiaProject
### ===================================================================================================================
### 2. Function to get a file based on different features
### ===================================================================================================================
[docs]def viia_get_file(
project: ViiaProject, path: Path, starts_with: Optional[str] = None, in_name: Optional[str] = None,
not_in_name: Optional[str] = None, suffix: Optional[str] = None) -> Optional[Path]:
"""
Function to find project files in a specified path, based on file name or extension.
Input:
- project (obj): Project object containing collections and of fem objects and project variables.
- path (Path): Path in which the function should check for the file.
- starts_with (str): String with which the file name should start in order to be eligible.
- in_name (str): File name should contain this string to be eligible.
- not_in_name (str): File name should not contain this string to be eligible.
- suffix (str): String describing the suffix/file-extension which the file should contain in order to be
eligible.
Output:
- File in path that satisfies the inputted search criteria.
"""
return fem_get_file(
project=project, path=path, starts_with=starts_with, in_name=in_name, not_in_name=not_in_name, suffix=suffix)
### ===================================================================================================================
### 3. End of script
### ===================================================================================================================