accounting/bench
2
0
Fork 0
mirror of https://github.com/frappe/bench.git synced 2024-11-16 01:57:08 +00:00
Code Issues Releases Activity

feat: Support Frappe app distributions with pyproject.toml

Browse Source 
Patches get_app_name which reads app name from pyproject's project.name
attribute, setup.cfg's metadata.name or setup.py's name variable.
This commit is contained in:
Gavin D'souza 2022-06-14 15:23:04 +05:30
parent 24e2dd37fe
commit 800394cdda
2 changed files with 27 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
bench/utils/app.py
View File

@ -1,6 +1,5 @@
import os import os
import re import re
from setuptools.config import read_configuration
import sys import sys
import subprocess import subprocess
from bench.exceptions import ( from bench.exceptions import (
@ -210,18 +209,36 @@ def get_remote(app, bench_path="."):
return contents.splitlines()[0].split()[0] return contents.splitlines()[0].split()[0]
def get_app_name(bench_path, folder_name): def get_app_name(bench_path: str, folder_name: str) -> str:
"""Retrieves `name` attribute of app - equivalent to distribution name
of python package. Fetches from pyproject.toml, setup.cfg or setup.py
whichever defines it in that order.
"""
app_name = None app_name = None
apps_path = os.path.join(os.path.abspath(bench_path), "apps") apps_path = os.path.join(os.path.abspath(bench_path), "apps")
config_path = os.path.join(apps_path, folder_name, "setup.cfg")
if os.path.exists(config_path): pyproject_path = os.path.join(apps_path, folder_name, "pyproject.toml")
config = read_configuration(config_path) config_py_path = os.path.join(apps_path, folder_name, "setup.cfg")
setup_py_path = os.path.join(apps_path, folder_name, "setup.py")
if os.path.exists(pyproject_path):
try:
from tomli import load
except ImportError:
from tomllib import load
with open(pyproject_path, "rb") as f:
app_name = load(f).get("project", {}).get("name")
if not app_name and os.path.exists(config_py_path):
from setuptools.config import read_configuration
config = read_configuration(config_py_path)
app_name = config.get("metadata", {}).get("name") app_name = config.get("metadata", {}).get("name")
if not app_name: if not app_name:
# retrieve app name from setup.py as fallback # retrieve app name from setup.py as fallback
app_path = os.path.join(apps_path, folder_name, "setup.py") with open(setup_py_path, "rb") as f:
with open(app_path, "rb") as f:
app_name = re.search(r'name\s*=\s*[\'"](.*)[\'"]', f.read().decode("utf-8")).group(1) app_name = re.search(r'name\s*=\s*[\'"](.*)[\'"]', f.read().decode("utf-8")).group(1)
if app_name and folder_name != app_name: if app_name and folder_name != app_name:
@ -245,6 +262,8 @@ def get_current_version(app, bench_path="."):
try: try:
if os.path.exists(config_path): if os.path.exists(config_path):
from setuptools.config import read_configuration
config = read_configuration(config_path) config = read_configuration(config_path)
current_version = config.get("metadata", {}).get("version") current_version = config.get("metadata", {}).get("version")
if not current_version: if not current_version:

1
requirements.txt
View File

@ -6,3 +6,4 @@ python-crontab~=2.4.0
requests requests
semantic-version~=2.8.2 semantic-version~=2.8.2
setuptools setuptools
tomli;python_version<"3.11"