1
0
mirror of https://github.com/huggingface/diffusers.git synced 2026-10-27 21:33:02 +03:00
Files
diffusers/tests/others/test_check_copies.py
Sayak Paul 7aa57aafff [tests] Migrate tests/others to pytest. (#14299)
* download kernels when users request for it.

* migrate tests/others to pytest

* Revert "download kernels when users request for it."

This reverts commit 6fe34ade6b.

---------

Co-authored-by: dg845 <58458699+dg845@users.noreply.github.com>
2026-08-04 23:03:21 +08:00

122 lines
4.9 KiB
Python

# Copyright 2026 The HuggingFace Team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# 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.
import os
import re
import shutil
import sys
import pytest
git_repo_path = os.path.abspath(os.path.dirname(os.path.dirname(os.path.dirname(__file__))))
sys.path.append(os.path.join(git_repo_path, "utils"))
import check_copies # noqa: E402
# This is the reference code that will be used in the tests.
# If DDPMSchedulerOutput is changed in scheduling_ddpm.py, this code needs to be manually updated.
REFERENCE_CODE = """ \"""
Output class for the scheduler's `step` function output.
Args:
prev_sample (`torch.Tensor` of shape `(batch_size, num_channels, height, width)` for images):
Computed sample `(x_{t-1})` of previous timestep. `prev_sample` should be used as next model input in the
denoising loop.
pred_original_sample (`torch.Tensor` of shape `(batch_size, num_channels, height, width)` for images):
The predicted denoised sample `(x_{0})` based on the model output from the current timestep.
`pred_original_sample` can be used to preview progress or for guidance.
\"""
prev_sample: torch.Tensor
pred_original_sample: torch.Tensor | None = None
"""
class TestCopyCheck:
@pytest.fixture
def diffusers_dir(self, tmp_path, monkeypatch):
"""A stand-in `src/diffusers` holding only `scheduling_ddpm.py`, pointed at by `check_copies`."""
os.makedirs(tmp_path / "schedulers")
shutil.copy(
os.path.join(git_repo_path, "src/diffusers/schedulers/scheduling_ddpm.py"),
tmp_path / "schedulers" / "scheduling_ddpm.py",
)
monkeypatch.setattr(check_copies, "DIFFUSERS_PATH", str(tmp_path))
return tmp_path
def check_copy_consistency(self, diffusers_dir, comment, class_name, class_code, overwrite_result=None):
code = comment + f"\nclass {class_name}(nn.Module):\n" + class_code
if overwrite_result is not None:
expected = comment + f"\nclass {class_name}(nn.Module):\n" + overwrite_result
code = check_copies.run_ruff(code)
fname = diffusers_dir / "new_code.py"
with open(fname, "w", newline="\n") as f:
f.write(code)
if overwrite_result is None:
assert len(check_copies.is_copy_consistent(fname)) == 0
else:
check_copies.is_copy_consistent(fname, overwrite=True)
with open(fname, "r") as f:
assert f.read() == expected
def test_find_code_in_diffusers(self, diffusers_dir):
# `diffusers_dir` is requested for its `DIFFUSERS_PATH` patch — the lookup below resolves against it.
code = check_copies.find_code_in_diffusers("schedulers.scheduling_ddpm.DDPMSchedulerOutput")
assert code == REFERENCE_CODE
def test_is_copy_consistent(self, diffusers_dir):
# Base copy consistency
self.check_copy_consistency(
diffusers_dir,
"# Copied from diffusers.schedulers.scheduling_ddpm.DDPMSchedulerOutput",
"DDPMSchedulerOutput",
REFERENCE_CODE + "\n",
)
# With no empty line at the end
self.check_copy_consistency(
diffusers_dir,
"# Copied from diffusers.schedulers.scheduling_ddpm.DDPMSchedulerOutput",
"DDPMSchedulerOutput",
REFERENCE_CODE,
)
# Copy consistency with rename
self.check_copy_consistency(
diffusers_dir,
"# Copied from diffusers.schedulers.scheduling_ddpm.DDPMSchedulerOutput with DDPM->Test",
"TestSchedulerOutput",
re.sub("DDPM", "Test", REFERENCE_CODE),
)
# Copy consistency with a really long name
long_class_name = "TestClassWithAReallyLongNameBecauseSomePeopleLikeThatForSomeReason"
self.check_copy_consistency(
diffusers_dir,
f"# Copied from diffusers.schedulers.scheduling_ddpm.DDPMSchedulerOutput with DDPM->{long_class_name}",
f"{long_class_name}SchedulerOutput",
re.sub("Bert", long_class_name, REFERENCE_CODE),
)
# Copy consistency with overwrite
self.check_copy_consistency(
diffusers_dir,
"# Copied from diffusers.schedulers.scheduling_ddpm.DDPMSchedulerOutput with DDPM->Test",
"TestSchedulerOutput",
REFERENCE_CODE,
overwrite_result=re.sub("DDPM", "Test", REFERENCE_CODE),
)