feast/sdk/python/feast/cli.py at master · astefano/feast · GitHub

History

790 lines (685 loc) · 20.6 KB

Raw

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

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

# 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

# https://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 json

import logging

from datetime import datetime

from pathlib import Path

from typing import List, Optional

import click

import pkg_resources

import yaml

from colorama import Fore, Style

from dateutil import parser

from pygments import formatters, highlight, lexers

from feast import utils

from feast.constants import DEFAULT_FEATURE_TRANSFORMATION_SERVER_PORT

from feast.errors import FeastObjectNotFoundException, FeastProviderLoginError

from feast.feature_view import FeatureView

from feast.on_demand_feature_view import OnDemandFeatureView

from feast.repo_config import load_repo_config

from feast.repo_operations import (

apply_total,

cli_check_repo,

create_feature_store,

generate_project_name,

init_repo,

plan,

registry_dump,

teardown,

)

from feast.repo_upgrade import RepoUpgrader

from feast.utils import maybe_local_tz

_logger = logging.getLogger(__name__)

class NoOptionDefaultFormat(click.Command):

def format_options(self, ctx: click.Context, formatter: click.HelpFormatter):

"""Writes all the options into the formatter if they exist."""

opts = []

for param in self.get_params(ctx):

rv = param.get_help_record(ctx)

if rv is not None:

opts.append(rv)

if opts:

with formatter.section("Options(No current command options)"):

formatter.write_dl(opts)

@click.group()

@click.option(

"--chdir",

"-c",

help="Switch to a different feature repository directory before executing the given subcommand.",

)

@click.option(

"--log-level",

default="info",

help="The logging level. One of DEBUG, INFO, WARNING, ERROR, and CRITICAL (case-insensitive).",

)

@click.option(

"--feature-store-yaml",

help="Override the directory where the CLI should look for the feature_store.yaml file.",

)

@click.pass_context

def cli(

ctx: click.Context,

chdir: Optional[str],

log_level: str,

feature_store_yaml: Optional[str],

"""

Feast CLI

For more information, see our public docs at https://docs.feast.dev/

For any questions, you can reach us at https://slack.feast.dev/

"""

ctx.ensure_object(dict)

ctx.obj["CHDIR"] = Path.cwd() if chdir is None else Path(chdir).absolute()

ctx.obj["FS_YAML_FILE"] = (

Path(feature_store_yaml).absolute()

if feature_store_yaml

else utils.get_default_yaml_file_path(ctx.obj["CHDIR"])

)

try:

level = getattr(logging, log_level.upper())

logging.basicConfig(

format="%(asctime)s %(name)s %(levelname)s: %(message)s",

datefmt="%m/%d/%Y %I:%M:%S %p",

level=level,

)

# Override the logging level for already created loggers (due to loggers being created at the import time)

# Note, that format & datefmt does not need to be set, because by default child loggers don't override them

# Also note, that mypy complains that logging.root doesn't have "manager" because of the way it's written.

# So we have to put a type ignore hint for mypy.

for logger_name in logging.root.manager.loggerDict: # type: ignore

if "feast" in logger_name:

logger = logging.getLogger(logger_name)

logger.setLevel(level)

except Exception as e:

raise e

pass

@cli.command()

def version():

"""

Display Feast SDK version

"""

print(f'Feast SDK Version: "{pkg_resources.get_distribution("feast")}"')

@cli.command()

@click.option(

"--host",

"-h",

type=click.STRING,

default="0.0.0.0",

show_default=True,

help="Specify a host for the server",

)

@click.option(

"--port",

"-p",

type=click.INT,

default=8888,

show_default=True,

help="Specify a port for the server",

)

@click.option(

"--registry_ttl_sec",

"-r",

help="Number of seconds after which the registry is refreshed",

type=click.INT,

default=5,

show_default=True,

)

@click.option(

"--root_path",

help="Provide root path to make the UI working behind proxy",

type=click.STRING,

default="",

)

@click.pass_context

def ui(

ctx: click.Context,

host: str,

port: int,

registry_ttl_sec: int,

root_path: Optional[str] = "",

"""

Shows the Feast UI over the current directory

"""

store = create_feature_store(ctx)

# Pass in the registry_dump method to get around a circular dependency

store.serve_ui(

host=host,

port=port,

get_registry_dump=registry_dump,

registry_ttl_sec=registry_ttl_sec,

root_path=root_path,

)

@cli.command()

@click.pass_context

def endpoint(ctx: click.Context):

"""

Display feature server endpoints

"""

store = create_feature_store(ctx)

endpoint = store.get_feature_server_endpoint()

if endpoint is not None:

_logger.info(

f"Feature server endpoint: {Style.BRIGHT + Fore.GREEN}{endpoint}{Style.RESET_ALL}"

)

else:

_logger.info("There is no active feature server.")

@cli.group(name="data-sources")

def data_sources_cmd():

"""

Access data sources

"""

pass

@data_sources_cmd.command("describe")

@click.argument("name", type=click.STRING)

@click.pass_context

def data_source_describe(ctx: click.Context, name: str):

"""

Describe a data source

"""

store = create_feature_store(ctx)

try:

data_source = store.get_data_source(name)

except FeastObjectNotFoundException as e:

print(e)

exit(1)

print(

yaml.dump(

yaml.safe_load(str(data_source)), default_flow_style=False, sort_keys=False

)

@data_sources_cmd.command(name="list")

@click.pass_context

def data_source_list(ctx: click.Context):

"""

List all data sources

"""

store = create_feature_store(ctx)

table = []

for datasource in store.list_data_sources():

table.append([datasource.name, datasource.__class__])

from tabulate import tabulate

print(tabulate(table, headers=["NAME", "CLASS"], tablefmt="plain"))

@cli.group(name="entities")

def entities_cmd():

"""

Access entities

"""

pass

@entities_cmd.command("describe")

@click.argument("name", type=click.STRING)

@click.pass_context

def entity_describe(ctx: click.Context, name: str):

"""

Describe an entity

"""

store = create_feature_store(ctx)

try:

entity = store.get_entity(name)

except FeastObjectNotFoundException as e:

print(e)

exit(1)

print(

yaml.dump(

yaml.safe_load(str(entity)), default_flow_style=False, sort_keys=False

)

@entities_cmd.command(name="list")

@click.pass_context

def entity_list(ctx: click.Context):

"""

List all entities

"""

store = create_feature_store(ctx)

table = []

for entity in store.list_entities():

table.append([entity.name, entity.description, entity.value_type])

from tabulate import tabulate

print(tabulate(table, headers=["NAME", "DESCRIPTION", "TYPE"], tablefmt="plain"))

@cli.group(name="feature-services")

def feature_services_cmd():

"""

Access feature services

"""

pass

@feature_services_cmd.command("describe")

@click.argument("name", type=click.STRING)

@click.pass_context

def feature_service_describe(ctx: click.Context, name: str):

"""

Describe a feature service

"""

store = create_feature_store(ctx)

try:

feature_service = store.get_feature_service(name)

except FeastObjectNotFoundException as e:

print(e)

exit(1)

print(

yaml.dump(

yaml.safe_load(str(feature_service)),

default_flow_style=False,

sort_keys=False,

)

@feature_services_cmd.command(name="list")

@click.pass_context

def feature_service_list(ctx: click.Context):

"""

List all feature services

"""

store = create_feature_store(ctx)

feature_services = []

for feature_service in store.list_feature_services():

feature_names = []

for projection in feature_service.feature_view_projections:

feature_names.extend(

[f"{projection.name}:{feature.name}" for feature in projection.features]

)

feature_services.append([feature_service.name, ", ".join(feature_names)])

from tabulate import tabulate

print(tabulate(feature_services, headers=["NAME", "FEATURES"], tablefmt="plain"))

@cli.group(name="feature-views")

def feature_views_cmd():

"""

Access feature views

"""

pass

@feature_views_cmd.command("describe")

@click.argument("name", type=click.STRING)

@click.pass_context

def feature_view_describe(ctx: click.Context, name: str):

"""

Describe a feature view

"""

store = create_feature_store(ctx)

try:

feature_view = store.get_feature_view(name)

except FeastObjectNotFoundException as e:

print(e)

exit(1)

print(

yaml.dump(

yaml.safe_load(str(feature_view)), default_flow_style=False, sort_keys=False

)

@feature_views_cmd.command(name="list")

@click.pass_context

def feature_view_list(ctx: click.Context):

"""

List all feature views

"""

store = create_feature_store(ctx)

table = []

for feature_view in [

*store.list_feature_views(),

*store.list_request_feature_views(),

*store.list_on_demand_feature_views(),

entities = set()

if isinstance(feature_view, FeatureView):

entities.update(feature_view.entities)

elif isinstance(feature_view, OnDemandFeatureView):

for backing_fv in feature_view.source_feature_view_projections.values():

entities.update(store.get_feature_view(backing_fv.name).entities)

table.append(

[

feature_view.name,

entities if len(entities) > 0 else "n/a",

type(feature_view).__name__,

]

)

from tabulate import tabulate

print(tabulate(table, headers=["NAME", "ENTITIES", "TYPE"], tablefmt="plain"))

@cli.group(name="on-demand-feature-views")

def on_demand_feature_views_cmd():

"""

[Experimental] Access on demand feature views

"""

pass

@on_demand_feature_views_cmd.command("describe")

@click.argument("name", type=click.STRING)

@click.pass_context

def on_demand_feature_view_describe(ctx: click.Context, name: str):

"""

[Experimental] Describe an on demand feature view

"""

store = create_feature_store(ctx)

try:

on_demand_feature_view = store.get_on_demand_feature_view(name)

except FeastObjectNotFoundException as e:

print(e)

exit(1)

print(

yaml.dump(

yaml.safe_load(str(on_demand_feature_view)),

default_flow_style=False,

sort_keys=False,

)

@on_demand_feature_views_cmd.command(name="list")

@click.pass_context

def on_demand_feature_view_list(ctx: click.Context):

"""

[Experimental] List all on demand feature views

"""

store = create_feature_store(ctx)

table = []

for on_demand_feature_view in store.list_on_demand_feature_views():

table.append([on_demand_feature_view.name])

from tabulate import tabulate

print(tabulate(table, headers=["NAME"], tablefmt="plain"))

@cli.command("plan", cls=NoOptionDefaultFormat)

@click.option(

"--skip-source-validation",

is_flag=True,

help="Don't validate the data sources by checking for that the tables exist.",

)

@click.pass_context

def plan_command(ctx: click.Context, skip_source_validation: bool):

"""

Create or update a feature store deployment

"""

repo = ctx.obj["CHDIR"]

fs_yaml_file = ctx.obj["FS_YAML_FILE"]

cli_check_repo(repo, fs_yaml_file)

repo_config = load_repo_config(repo, fs_yaml_file)

try:

plan(repo_config, repo, skip_source_validation)

except FeastProviderLoginError as e:

print(str(e))

@cli.command("apply", cls=NoOptionDefaultFormat)

@click.option(

"--skip-source-validation",

is_flag=True,

help="Don't validate the data sources by checking for that the tables exist.",

)

@click.pass_context

def apply_total_command(ctx: click.Context, skip_source_validation: bool):

"""

Create or update a feature store deployment

"""

repo = ctx.obj["CHDIR"]

fs_yaml_file = ctx.obj["FS_YAML_FILE"]

cli_check_repo(repo, fs_yaml_file)

repo_config = load_repo_config(repo, fs_yaml_file)

try:

apply_total(repo_config, repo, skip_source_validation)

except FeastProviderLoginError as e:

print(str(e))

@cli.command("teardown", cls=NoOptionDefaultFormat)

@click.pass_context

def teardown_command(ctx: click.Context):

"""

Tear down deployed feature store infrastructure

"""

repo = ctx.obj["CHDIR"]

fs_yaml_file = ctx.obj["FS_YAML_FILE"]

cli_check_repo(repo, fs_yaml_file)

repo_config = load_repo_config(repo, fs_yaml_file)

teardown(repo_config, repo)

@cli.command("registry-dump")

@click.pass_context

def registry_dump_command(ctx: click.Context):

"""

Print contents of the metadata registry

"""

repo = ctx.obj["CHDIR"]

fs_yaml_file = ctx.obj["FS_YAML_FILE"]

cli_check_repo(repo, fs_yaml_file)

repo_config = load_repo_config(repo, fs_yaml_file)

click.echo(registry_dump(repo_config, repo_path=repo))

@cli.command("materialize")

@click.argument("start_ts")

@click.argument("end_ts")

@click.option(

"--views",

"-v",

help="Feature views to materialize",

multiple=True,

)

@click.pass_context

def materialize_command(

ctx: click.Context, start_ts: str, end_ts: str, views: List[str]

"""

Run a (non-incremental) materialization job to ingest data into the online store. Feast

will read all data between START_TS and END_TS from the offline store and write it to the

online store. If you don't specify feature view names using --views, all registered Feature

Views will be materialized.

START_TS and END_TS should be in ISO 8601 format, e.g. '2021-07-16T19:20:01'

"""

store = create_feature_store(ctx)

store.materialize(

feature_views=None if not views else views,

start_date=utils.make_tzaware(parser.parse(start_ts)),

end_date=utils.make_tzaware(parser.parse(end_ts)),

)

@cli.command("materialize-incremental")

@click.argument("end_ts")

@click.option(

"--views",

"-v",

help="Feature views to incrementally materialize",

multiple=True,

)

@click.pass_context

def materialize_incremental_command(ctx: click.Context, end_ts: str, views: List[str]):

"""

Run an incremental materialization job to ingest new data into the online store. Feast will read

all data from the previously ingested point to END_TS from the offline store and write it to the

online store. If you don't specify feature view names using --views, all registered Feature

Views will be incrementally materialized.

END_TS should be in ISO 8601 format, e.g. '2021-07-16T19:20:01'

"""

store = create_feature_store(ctx)

store.materialize_incremental(

feature_views=None if not views else views,

end_date=utils.make_tzaware(datetime.fromisoformat(end_ts)),

)

@cli.command("init")

@click.argument("PROJECT_DIRECTORY", required=False)

@click.option(

"--minimal", "-m", is_flag=True, help="Create an empty project repository"

)

@click.option(

"--template",

"-t",

type=click.Choice(

[

"local",

"gcp",

"aws",

"snowflake",

"spark",

"postgres",

"hbase",

"cassandra",

"rockset",

"hazelcast",

case_sensitive=False,

help="Specify a template for the created project",

default="local",

)

def init_command(project_directory, minimal: bool, template: str):

"""Create a new Feast repository"""

if not project_directory:

project_directory = generate_project_name()

if minimal:

template = "minimal"

init_repo(project_directory, template)

@cli.command("serve")

@click.option(

"--host",

"-h",

type=click.STRING,

default="127.0.0.1",

show_default=True,

help="Specify a host for the server",

)

@click.option(

"--port",

"-p",

type=click.INT,

default=6566,

show_default=True,

help="Specify a port for the server",

)

@click.option(

"--type",

"-t",

"type_",

type=click.STRING,

default="http",

show_default=True,

help="Specify a server type: 'http' or 'grpc'",

)

@click.option(

"--no-access-log",

is_flag=True,

show_default=True,

help="Disable the Uvicorn access log",

)

@click.option(

"--no-feature-log",

is_flag=True,

show_default=True,

help="Disable logging served features",

)

@click.option(

"--workers",

"-w",

type=click.INT,

default=1,

show_default=True,

help="Number of worker",

)

@click.option(

"--keep-alive-timeout",

type=click.INT,

default=5,

show_default=True,

help="Timeout for keep alive",

)

@click.pass_context

def serve_command(

ctx: click.Context,

host: str,

port: int,

type_: str,

no_access_log: bool,

no_feature_log: bool,

workers: int,

keep_alive_timeout: int,

"""Start a feature server locally on a given port."""

store = create_feature_store(ctx)

store.serve(

host=host,

port=port,

type_=type_,

no_access_log=no_access_log,

no_feature_log=no_feature_log,

workers=workers,

keep_alive_timeout=keep_alive_timeout,

)

@cli.command("serve_transformations")

@click.option(

"--port",

"-p",

type=click.INT,

default=DEFAULT_FEATURE_TRANSFORMATION_SERVER_PORT,

help="Specify a port for the server",

)

@click.pass_context

def serve_transformations_command(ctx: click.Context, port: int):

"""[Experimental] Start a feature consumption server locally on a given port."""

store = create_feature_store(ctx)

store.serve_transformations(port)

@cli.command("validate")

@click.option(

"--feature-service",

"-f",

help="Specify a feature service name",

)

@click.option(

"--reference",

"-r",

help="Specify a validation reference name",

)

@click.option(

"--no-profile-cache",

is_flag=True,

help="Do not store cached profile in registry",

)

@click.argument("start_ts")

@click.argument("end_ts")

@click.pass_context

def validate(

ctx: click.Context,

feature_service: str,

reference: str,

start_ts: str,

end_ts: str,

no_profile_cache,

"""

Perform validation of logged features (produced by a given feature service) against provided reference.

START_TS and END_TS should be in ISO 8601 format, e.g. '2021-07-16T19:20:01'

"""

store = create_feature_store(ctx)

feature_service = store.get_feature_service(name=feature_service)

reference = store.get_validation_reference(reference)

result = store.validate_logged_features(

source=feature_service,

reference=reference,

start=maybe_local_tz(datetime.fromisoformat(start_ts)),

end=maybe_local_tz(datetime.fromisoformat(end_ts)),

throw_exception=False,

cache_profile=not no_profile_cache,

)

if not result:

print(f"{Style.BRIGHT + Fore.GREEN}Validation successful!{Style.RESET_ALL}")

return

errors = [e.to_dict() for e in result.report.errors]

formatted_json = json.dumps(errors, indent=4)

colorful_json = highlight(

formatted_json, lexers.JsonLexer(), formatters.TerminalFormatter()

)

print(f"{Style.BRIGHT + Fore.RED}Validation failed!{Style.RESET_ALL}")

print(colorful_json)

exit(1)

@cli.command("repo-upgrade", cls=NoOptionDefaultFormat)

@click.option(

"--write",

is_flag=True,

default=False,

help="Upgrade a feature repo to use the API expected by feast 0.23.",

)

@click.pass_context

def repo_upgrade(ctx: click.Context, write: bool):

"""

Upgrade a feature repo in place.

"""

repo = ctx.obj["CHDIR"]

fs_yaml_file = ctx.obj["FS_YAML_FILE"]

cli_check_repo(repo, fs_yaml_file)

try:

RepoUpgrader(repo, write).upgrade()

except FeastProviderLoginError as e:

print(str(e))

if __name__ == "__main__":

cli()

feast/sdk/python/feast/cli.py at master · astefano/feast · GitHub

Expand file tree

Breadcrumbs

cli.py

Latest commit

History

Breadcrumbs

cli.py

File metadata and controls