Allows for interaction with a BitBucket repository.
The BitBucket class in this collection is a storage block that lets Prefect agents
pull Prefect flow code from BitBucket repositories.
The BitBucket block is ideally configured via the Prefect UI, but can also be used
in Python as the following examples demonstrate.
Examples
```python
from prefect_bitbucket.repository import BitBucketRepository
public BitBucket repository
public_bitbucket_block = BitBucketRepository(
repository="https://bitbucket.com/my-project/my-repository.git"
)
public_bitbucket_block.save(name="my-bitbucket-block")
specific branch or tag
branch_bitbucket_block = BitBucketRepository(
reference="branch-or-tag-name",
repository="https://bitbucket.com/my-project/my-repository.git"
)
branch_bitbucket_block.save(name="my-bitbucket-block")
private BitBucket repository
private_bitbucket_block = BitBucketRepository(
repository="https://bitbucket.com/my-project/my-repository.git",
bitbucket_credentials=BitBucketCredentials.load("my-bitbucket-credentials-block")
)
private_bitbucket_block.save(name="my-private-bitbucket-block")
BitBucketRepository
Bases: ReadableDeploymentStorage
Interact with files stored in BitBucket repositories.
An accessible installation of git is required for this block to function
properly.
Source code in prefect_bitbucket/repository.py
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 | class BitBucketRepository(ReadableDeploymentStorage):
"""Interact with files stored in BitBucket repositories.
An accessible installation of git is required for this block to function
properly.
"""
_block_type_name = "BitBucket Repository"
_logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/5d729f7355fb6828c4b605268ded9cfafab3ae4f-250x250.png" # noqa
_description = "Interact with files stored in BitBucket repositories."
repository: str = Field(
default=...,
description="The URL of a BitBucket repository to read from in HTTPS format",
)
reference: Optional[str] = Field(
default=None,
description="An optional reference to pin to; can be a branch or tag.",
)
bitbucket_credentials: Optional[BitBucketCredentials] = Field(
default=None,
description=(
"An optional BitBucketCredentials block for authenticating with "
"private BitBucket repos."
),
)
@validator("bitbucket_credentials")
def _ensure_credentials_go_with_https(cls, v: str, values: dict) -> str:
"""Ensure that credentials are not provided with 'SSH' formatted BitBucket URLs.
Validators are by default only called on provided arguments.
Note: validates `credentials` specifically so that it only fires when private
repositories are used.
"""
if v is not None:
if urlparse(values["repository"]).scheme != "https":
raise InvalidRepositoryURLError(
(
"Credentials can only be used with BitBucket repositories "
"using the 'HTTPS' format. You must either remove the "
"credential if you wish to use the 'SSH' format and are not "
"using a private repository, or you must change the repository "
"URL to the 'HTTPS' format."
)
)
return v
def _create_repo_url(self) -> str:
"""Format the URL provided to the `git clone` command.
For private repos in the cloud:
https://x-token-auth:<access-token>@bitbucket.org/<user>/<repo>.git
For private repos with a local bitbucket server:
https://<username>:<access-token>@<server>/scm/<project>/<repo>.git
All other repos should be the same as `self.repository`.
"""
url_components = urlparse(self.repository)
token_is_set = (
self.bitbucket_credentials is not None and self.bitbucket_credentials.token
)
# Need a token for private repos
if url_components.scheme == "https" and token_is_set:
token = self.bitbucket_credentials.token.get_secret_value()
username = self.bitbucket_credentials.username
if username is None:
username = "x-token-auth"
updated_components = url_components._replace(
netloc=f"{username}:{token}@{url_components.netloc}"
)
full_url = urlunparse(updated_components)
else:
full_url = self.repository
return full_url
@staticmethod
def _get_paths(
dst_dir: Union[str, None], src_dir: str, sub_directory: Optional[str]
) -> Tuple[str, str]:
"""Return the fully formed paths for BitBucketRepository contents.
Return will take the form of (content_source, content_destination).
"""
if dst_dir is None:
content_destination = Path(".").absolute()
else:
content_destination = Path(dst_dir)
content_source = Path(src_dir)
if sub_directory:
content_destination = content_destination.joinpath(sub_directory)
content_source = content_source.joinpath(sub_directory)
return str(content_source), str(content_destination)
@sync_compatible
async def get_directory(
self, from_path: Optional[str] = None, local_path: Optional[str] = None
) -> None:
"""Clones a BitBucket project within `from_path` to the provided `local_path`.
This defaults to cloning the repository reference configured on the
Block to the present working directory.
Args:
from_path: If provided, interpreted as a subdirectory of the underlying
repository that will be copied to the provided local path.
local_path: A local path to clone to; defaults to present working directory.
"""
# Construct command
cmd = ["git", "clone", self._create_repo_url()]
if self.reference:
cmd += ["-b", self.reference]
# Limit git history
cmd += ["--depth", "1"]
# Clone to a temporary directory and move the subdirectory over
with TemporaryDirectory(suffix="prefect") as tmp_dir:
cmd.append(tmp_dir)
err_stream = io.StringIO()
out_stream = io.StringIO()
process = await run_process(cmd, stream_output=(out_stream, err_stream))
if process.returncode != 0:
err_stream.seek(0)
raise OSError(f"Failed to pull from remote:\n {err_stream.read()}")
content_source, content_destination = self._get_paths(
dst_dir=local_path, src_dir=tmp_dir, sub_directory=from_path
)
shutil.copytree(
src=content_source, dst=content_destination, dirs_exist_ok=True
)
|
get_directory
async
Clones a BitBucket project within from_path to the provided local_path.
This defaults to cloning the repository reference configured on the
Block to the present working directory.
Parameters:
| Name |
Type |
Description |
Default |
from_path
|
Optional[str]
|
If provided, interpreted as a subdirectory of the underlying
repository that will be copied to the provided local path.
|
None
|
local_path
|
Optional[str]
|
A local path to clone to; defaults to present working directory.
|
None
|
Source code in prefect_bitbucket/repository.py
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 | @sync_compatible
async def get_directory(
self, from_path: Optional[str] = None, local_path: Optional[str] = None
) -> None:
"""Clones a BitBucket project within `from_path` to the provided `local_path`.
This defaults to cloning the repository reference configured on the
Block to the present working directory.
Args:
from_path: If provided, interpreted as a subdirectory of the underlying
repository that will be copied to the provided local path.
local_path: A local path to clone to; defaults to present working directory.
"""
# Construct command
cmd = ["git", "clone", self._create_repo_url()]
if self.reference:
cmd += ["-b", self.reference]
# Limit git history
cmd += ["--depth", "1"]
# Clone to a temporary directory and move the subdirectory over
with TemporaryDirectory(suffix="prefect") as tmp_dir:
cmd.append(tmp_dir)
err_stream = io.StringIO()
out_stream = io.StringIO()
process = await run_process(cmd, stream_output=(out_stream, err_stream))
if process.returncode != 0:
err_stream.seek(0)
raise OSError(f"Failed to pull from remote:\n {err_stream.read()}")
content_source, content_destination = self._get_paths(
dst_dir=local_path, src_dir=tmp_dir, sub_directory=from_path
)
shutil.copytree(
src=content_source, dst=content_destination, dirs_exist_ok=True
)
|