-
Notifications
You must be signed in to change notification settings - Fork 13.7k
/
filesystem.py
89 lines (74 loc) · 2.8 KB
/
filesystem.py
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
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.
from __future__ import annotations
from pathlib import Path
from typing import Any
from airflow.hooks.base import BaseHook
class FSHook(BaseHook):
"""
Allows for interaction with an file server.
Connection should have a name and a path specified under extra:
example:
Connection Id: fs_test
Connection Type: File (path)
Host, Schema, Login, Password, Port: empty
Extra: {"path": "/tmp"}
"""
conn_name_attr = "fs_conn_id"
default_conn_name = "fs_default"
conn_type = "fs"
hook_name = "File (path)"
@classmethod
def get_connection_form_widgets(cls) -> dict[str, Any]:
"""Return connection widgets to add to connection form."""
from flask_appbuilder.fieldwidgets import BS3TextFieldWidget
from flask_babel import lazy_gettext
from wtforms import StringField
return {"path": StringField(lazy_gettext("Path"), widget=BS3TextFieldWidget())}
@classmethod
def get_ui_field_behaviour(cls) -> dict[str, Any]:
"""Return custom field behaviour."""
return {
"hidden_fields": ["host", "schema", "port", "login", "password", "extra"],
"relabeling": {},
"placeholders": {},
}
def __init__(self, fs_conn_id: str = default_conn_name, **kwargs):
super().__init__(**kwargs)
conn = self.get_connection(fs_conn_id)
self.basepath = conn.extra_dejson.get("path", "")
self.conn = conn
def get_conn(self) -> None:
pass
def get_path(self) -> str:
"""
Get the path to the filesystem location.
:return: the path.
"""
return self.basepath
def test_connection(self):
"""Test File connection."""
try:
p = self.get_path()
if not p:
return False, "File Path is undefined."
if not Path(p).exists():
return False, f"Path {p} does not exist."
return True, f"Path {p} is existing."
except Exception as e:
return False, str(e)