Spaces:
Runtime error
Runtime error
File size: 10,771 Bytes
8a6cf24 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
from __future__ import annotations
import re
import shutil
import tempfile
from pathlib import Path
from typing import Annotated, Optional
import semantic_version
from huggingface_hub import HfApi
from rich import print
from rich.console import Console
from rich.panel import Panel
from rich.prompt import Confirm, Prompt
from tomlkit import parse
from typer import Argument, Option
from gradio.analytics import custom_component_analytics
colors = ["red", "yellow", "green", "blue", "indigo", "purple", "pink", "gray"]
PYPI_REGISTER_URL = "https://pypi.org/account/register/"
def _ignore(_src, names):
ignored = []
for n in names:
if "__pycache__" in n or n.startswith("dist") or n.startswith("node_modules"):
ignored.append(n)
return ignored
def _get_version_from_file(dist_file: Path) -> Optional[str]:
match = re.search(r"-(\d+\.\d+\.\d+[a-zA-Z]*\d*)-", dist_file.name)
if match:
return match.group(1)
def _get_max_version(distribution_files: list[Path]) -> Optional[str]:
versions = []
for p in distribution_files:
version = _get_version_from_file(p)
# If anything goes wrong, just return None so we upload all files
# better safe than sorry
if version:
try:
versions.append(semantic_version.Version(version))
except ValueError:
return None
return str(max(versions)) if versions else None
def _publish(
dist_dir: Annotated[
Path,
Argument(help=f"Path to the wheel directory. Default is {Path('.') / 'dist'}"),
] = Path(".") / "dist",
upload_pypi: Annotated[bool, Option(help="Whether to upload to PyPI.")] = True,
pypi_username: Annotated[str, Option(help="The username for PyPI.")] = "",
pypi_password: Annotated[str, Option(help="The password for PyPI.")] = "",
upload_demo: Annotated[
bool, Option(help="Whether to upload demo to HuggingFace.")
] = True,
demo_dir: Annotated[
Optional[Path], Option(help="Path to the demo directory.")
] = None,
source_dir: Annotated[
Path,
Option(help="Path to the source directory of the custom component."),
] = Path("."),
hf_token: Annotated[
Optional[str],
Option(
help="HuggingFace token for uploading demo. Can be omitted if already logged in via huggingface cli."
),
] = None,
prefer_local: Annotated[
bool,
Option(
help="Install the package from the local wheel in the demo space, even if it exists on PyPi."
),
] = False,
upload_source: Annotated[
bool,
Option(
help="Whether to upload the source code of the custom component, to share with the community."
),
] = False,
):
custom_component_analytics(
"publish",
None,
upload_demo=upload_demo,
upload_pypi=upload_pypi,
upload_source=upload_source,
)
console = Console()
dist_dir = dist_dir.resolve()
if not dist_dir.exists():
raise ValueError(
f"{dist_dir} does not exist. Run `gradio cc build` to create a wheel and source distribution."
)
if not dist_dir.is_dir():
raise ValueError(f"{dist_dir} is not a directory")
distribution_files = [
p.resolve() for p in Path(dist_dir).glob("*") if p.suffix in {".whl", ".gz"}
]
wheel_file = max(
(p for p in distribution_files if p.suffix == ".whl"),
key=lambda s: semantic_version.Version(str(s.name).split("-")[1]),
)
if not wheel_file:
raise ValueError(
"A wheel file was not found in the distribution directory. "
"Run `gradio cc build` to create a wheel file."
)
config_file = None
if upload_pypi and (not pypi_username or not pypi_password):
panel = Panel(
"It is recommended to upload your component to pypi so that [bold][magenta]anyone[/][/] "
"can install it with [bold][magenta]pip install[/][/].\n\n"
f"A PyPi account is needed. If you do not have an account, register account here: [blue]{PYPI_REGISTER_URL}[/]",
)
print(panel)
upload_pypi = Confirm.ask(":snake: Upload to pypi?")
if upload_pypi and (Path.home() / ".pypirc").exists():
print(":closed_lock_with_key: Found .pypirc file in home directory.")
config_file = str(Path.home() / ".pypirc")
elif upload_pypi:
print(
":light_bulb: If you have Two Factor Authentication enabled, the username is __token__ and your password is your API key."
)
pypi_username = Prompt.ask(":laptop_computer: Enter your pypi username")
pypi_password = Prompt.ask(
":closed_lock_with_key: Enter your pypi password", password=True
)
if upload_pypi:
try:
from twine.commands.upload import upload as twine_upload # type: ignore
from twine.exceptions import InvalidDistribution # type: ignore
from twine.settings import Settings # type: ignore
except (ImportError, ModuleNotFoundError) as e:
raise ValueError(
"The twine library must be installed to publish to pypi."
"Install it with pip, pip install twine."
) from e
if pypi_username and pypi_password:
twine_settings = Settings(username=pypi_username, password=pypi_password)
elif config_file:
twine_settings = Settings(config_file=config_file)
else:
raise ValueError(
"No pypi username or password provided and no ~/.pypirc file found."
)
try:
# do our best to only upload the latest versions
max_version = _get_max_version(distribution_files)
twine_files = [
str(p)
for p in distribution_files
if (not max_version or max_version in p.name)
]
print(f"Uploading files: {','.join(twine_files)}")
try:
twine_upload(twine_settings, twine_files)
except InvalidDistribution as e:
raise ValueError(
"Invalid distribution when uploading to pypi. "
"Try upgrading 'pkginfo' with python -m pip install pkginfo --upgrade"
) from e
except Exception:
console.print_exception()
if upload_demo and not demo_dir:
panel = Panel(
"It is recommended you upload a demo of your component to [blue]https://huggingface.co/spaces[/] "
"so that anyone can try it from their browser."
)
print(panel)
upload_demo = Confirm.ask(":hugging_face: Upload demo?")
if upload_demo:
panel = Panel(
"Please provide the path to the [magenta]demo directory[/] for your custom component.\n\n"
"This directory should contain [magenta]all the files[/] it needs to run successfully.\n\n"
"Please make sure the gradio app is in an [magenta]space.py[/] file.\n\n"
"If you need additional python requirements, add a [magenta]requirements.txt[/] file to this directory."
)
print(panel)
demo_dir_ = Prompt.ask(
f":roller_coaster: Please enter the path to the demo directory. Leave blank to use: {(Path('.') / 'demo')}"
)
demo_dir_ = demo_dir_ or str(Path(".") / "demo")
demo_dir = Path(demo_dir_).resolve()
if upload_demo and not upload_source:
panel = Panel(
"It is recommended that you share your [magenta]source code[/] so that others can learn from and improve your component."
)
print(panel)
upload_source = Confirm.ask(":books: Would you like to share your source code?")
if upload_source:
source_dir_ = (
Prompt.ask(
f":file_folder: Please enter the path to the source directory. Leave blank to use: {source_dir}"
)
or source_dir
)
source_dir = Path(source_dir_).resolve()
if upload_demo:
pyproject_toml_path = source_dir / "pyproject.toml"
try:
pyproject_toml = parse(pyproject_toml_path.read_text())
package_name = pyproject_toml["project"]["name"] # type: ignore
except Exception:
(package_name, _) = wheel_file.name.split("-")[:2]
if not demo_dir:
raise ValueError("demo_dir must be set")
package_name, _ = wheel_file.name.split("-")[:2]
with tempfile.TemporaryDirectory() as tempdir:
shutil.copytree(
str(demo_dir),
str(tempdir),
dirs_exist_ok=True,
)
shutil.copyfile(
str(source_dir / ".gitignore"),
str(Path(tempdir) / ".gitignore"),
)
if upload_source:
shutil.copytree(
str(source_dir),
str(Path(tempdir) / "src"),
dirs_exist_ok=True,
ignore=_ignore,
)
shutil.copyfile(
str(source_dir / "README.md"), str(Path(tempdir) / "README.md")
)
api = HfApi(token=hf_token)
repo_url = api.create_repo(
repo_id=package_name,
repo_type="space",
exist_ok=True,
space_sdk="gradio",
)
repo_id = repo_url.repo_id
api.upload_folder(
repo_id=repo_id,
folder_path=tempdir,
repo_type="space",
)
if prefer_local:
api.upload_file(
repo_id=repo_id,
path_or_fileobj=str(wheel_file),
path_in_repo=wheel_file.name,
repo_type="space",
)
print("\n")
# Do a factory reboot so that the new dependencies get installed
api.restart_space(repo_id=repo_id, factory_reboot=True, token=hf_token)
print(f"Demo uploaded to https://huggingface.co/spaces/{repo_id} !")
def resolve_demo(demo_dir: Path) -> Path:
_demo_dir = demo_dir.resolve()
if (_demo_dir / "space.py").exists():
return _demo_dir / "space.py"
elif (_demo_dir / "app.py").exists():
return _demo_dir / "app.py"
else:
raise FileNotFoundError(
f'Could not find "space.py" or "app.py" in "{demo_dir}".'
)
|