lines: list[str],

start_line_index: int,

start_char_index: int,

matching_char: str = "{",

) -> tuple[int, int]:

"""Finds the position of the matching closing bracket from a list of lines.

matching_line_index = -1

matching_char_index = -1

matching_chars = {"{": "}", "(": ")", "[": "]"}

if matching_char not in matching_chars:

characters = ", ".join(matching_chars)

print(f"The matching character must be one of the following: {characters}")

return matching_line_index, matching_char_index

# Create a deque to use it as a stack.

d = collections.deque()

for line_index in range(start_line_index, len(lines)):

line = lines[line_index]

# deal with the line where the starting bracket is located.

if line_index == start_line_index:

line = lines[line_index][start_char_index:]

for index, item in enumerate(line):

# Pops a starting bracket for each closing bracket.

if item == matching_chars[matching_char]:

d.popleft()

# Push all starting brackets.

elif item == matching_char:

d.append(matching_char)

# If deque becomes empty.

if not d:

matching_line_index = line_index

if line_index == start_line_index:

matching_char_index = start_char_index + index

else:

matching_char_index = index

return matching_line_index, matching_char_index

"""Formats keys in a dictionary and adds quotes to the keys.

new_line = line

prefix = ""

if line.strip().startswith("for"): # skip for loop

return line

# Find all occurrences of a substring.

def find_all(a_str, sub):

start = 0

while True:

start = a_str.find(sub, start)

if start == -1:

return

yield start

start += len(sub) # Use start += 1 to find overlapping matches.

indices = list(find_all(line, sep))

count = len(indices)

if "{" in line:

bracket_index = line.index("{")

if bracket_index < indices[0]:

prefix = line[: bracket_index + 1]

line = line[bracket_index + 1 :]

if count > 0:

items = line.split(sep)

if count == 1:

for i in range(0, count):

item = items[i].strip()

if ('"' not in item) and ("'" not in item):

new_item = "'" + item + "'"

items[i] = items[i].replace(item, new_item)

new_line = ":".join(items)

elif count > 1:

for i in range(0, count):

item = items[i]

if "," in item:

subitems = item.split(",")

subitem = subitems[-1]

if ('"' not in subitem) and ("'" not in subitem):

new_subitem = "'" + subitem.strip() + "'"

subitems[-1] = subitems[-1].replace(subitem, new_subitem)

items[i] = ", ".join(subitems)

else:

if ('"' not in item) and ("'" not in item):

new_item = "'" + item.strip() + "'"

padding = len(item) - len(item.strip())

items[i] = " " * padding + item.replace(item, new_item)

new_line = ":".join(items)

"""Checks if an Earth Engine uses Math library.

math_import = False

for line in lines:

if "Math." in line:

math_import = True

"""Converts JavaScript for loop to Python for loop.

if "var " in line:

line = line.replace("var ", "")

start_index = line.index("(")

end_index = line.index(")")

prefix = line[:(start_index)]

suffix = line[(end_index + 1) :]

params = line[(start_index + 1) : end_index]

if " in " in params and params.count(";") == 0:

new_line = prefix + f"{params}:" + suffix

return new_line

items = params.split("=")

param_name = items[0].strip()

items = params.split(";")

subitems = []

for item in items:

subitems.append(item.split(" ")[-1])

start = subitems[0]

end = subitems[1]

step = subitems[2]

if "++" in step:

step = 1

elif "--" in step:

step = -1

prefix = line[:(start_index)]

suffix = line[(end_index + 1) :]

new_line = prefix + f"{param_name} in range({start}, {end}, {step}):" + suffix

"""Removes indentation for reformatting with Python's indentation rules.

output_lines = []

for _, line in enumerate(input_lines):

output_lines.append(line.lstrip())

"""Extracts Earth Engine map function.

output_lines = []

current_num_of_nested_funcs = 0

for index, line in enumerate(input_lines):

if (

line.strip().endswith(".map(")

and input_lines[index + 1].strip().replace(" ", "").startswith("function(")

) or (

line.strip().endswith(".map(function(")

and input_lines[index + 1].strip().replace(" ", "").endswith("{")

):

input_lines[index + 1] = ( # pyrefly: ignore[unsupported-operation]

line + input_lines[index + 1]

) # pytype: disable=unsupported-operands

continue

if (

".map(function" in line.replace(" ", "")

or "returnfunction" in line.replace(" ", "")

or "function(" in line.replace(" ", "")

):

try:

bracket_index = line.index("{")

matching_line_index, matching_char_index = find_matching_bracket(

input_lines, index, bracket_index # pyrefly: ignore[bad-argument-type]

) # pytype: disable=wrong-arg-types

func_start_index = line.index("function")

func_name = "func_" + coreutils.random_string()

func_header = line[func_start_index:].replace(

"function", "function " + func_name

)

output_lines.append("\n")

output_lines.append(func_header)

current_num_of_nested_funcs += 1

new_lines = input_lines[index + 1 : matching_line_index]

new_lines = check_map_functions(new_lines)

for sub_index, tmp_line in enumerate(new_lines):

output_lines.append(

(" " * current_num_of_nested_funcs) + tmp_line

)

if "{" in tmp_line:

current_num_of_nested_funcs += 1

if "}" in tmp_line:

current_num_of_nested_funcs -= 1

input_lines[index + 1 + sub_index] = ( # pyrefly: ignore[unsupported-operation]

"" # pytype: disable=unsupported-operands

)

current_num_of_nested_funcs -= 1

header_line = line[:func_start_index] + func_name

header_line = header_line.rstrip()

func_footer = input_lines[matching_line_index][

: matching_char_index + 1

]

output_lines.append(func_footer)

footer_line = input_lines[matching_line_index][

matching_char_index + 1 :

].strip()

if footer_line == ")" or footer_line == ");":

header_line = header_line + footer_line

footer_line = ""

input_lines[matching_line_index] = ( # pyrefly: ignore[unsupported-operation]

footer_line # pytype: disable=unsupported-operands

)

output_lines.append(header_line)

except Exception as e:

print(

f"An error occurred: {e}. "

f"The closing curly bracket could not be found in Line {index+1}: "

f"{line}. Please reformat the function definition and make sure "

"that both the opening and closing curly brackets appear on the "

"same line as the function keyword."

)

else:

output_lines.append(line)

in_file: str,

out_file: str | None = None,

use_qgis: bool = True,

github_repo: str | None = None,

show_map: bool = True,

import_geemap: bool = False,

Map: str = "m",

) -> str | None:

"""Converts an Earth Engine JavaScript to Python script.

in_file = os.path.abspath(in_file)

if out_file is None:

out_file = in_file.replace(".js", ".py")

root_dir = os.path.dirname(os.path.abspath(__file__))

if not os.path.isfile(in_file):

in_file = os.path.join(root_dir, in_file)

if not os.path.isfile(out_file):

out_file = os.path.join(root_dir, out_file)

is_python = False

if use_qgis and import_geemap:

raise Exception(

"use_qgis and import_geemap cannot be both True. "

"Please set one of them to False."

)

import_str = ""

if use_qgis:

import_str = "from ee_plugin import Map\n"

if import_geemap:

import_str = f"import geemap\n\n{Map} = geemap.Map()\n"

github_url = ""

if github_repo is not None:

github_url = "# GitHub URL: " + github_repo + in_file + "\n\n"

math_import = False

math_import_str = ""

lines = []

with open(in_file, encoding="utf-8") as f:

lines = f.readlines()

math_import = use_math(lines)

for line in lines:

line = line.strip()

if line == "import ee":

is_python = True

if math_import:

math_import_str = "import math\n"

output = ""

if is_python: # Only update the GitHub URL if it is already a GEE Python script.

output = github_url + "".join(map(str, lines))

else: # Deal with JavaScript.

header = github_url + "import ee \n" + math_import_str + import_str

# function_defs = []

output = header + "\n"

with open(in_file, encoding="utf-8") as f:

lines = f.readlines()

num_incorrect_parameters = 0

check_next_line_for_print = False

should_check_for_empty_lines = False

current_dictionary_scope_depth = 0

current_num_of_nested_funcs = 0

# We need to remove all spaces from the beginning of each line to accurately

# format the indentation.

lines = remove_all_indentation(lines)

lines = check_map_functions(lines)

for index, line in enumerate(lines):

if "Map.setOptions" in line:

# Regular expression to remove everything after the comma and before

# ');'.

line = re.sub(r",[^)]+(?=\);)", "", line)

if ("/* color" in line) and ("*/" in line):

line = (

line[: line.index("/*")].lstrip()

+ line[(line.index("*/") + 2) :]

)

if (

("= function" in line)

or ("=function" in line)

or line.strip().startswith("function")

):

try:

bracket_index = line.index("{")

(

matching_line_index,

matching_char_index,

) = find_matching_bracket(lines, index, bracket_index)

if "func_" not in line:

current_num_of_nested_funcs += 1

for sub_index, tmp_line in enumerate(

lines[index + 1 : matching_line_index]

):

if "{" in tmp_line and "function" not in line:

current_num_of_nested_funcs += 1

if "}" in tmp_line and "function" not in line:

current_num_of_nested_funcs -= 1

lines[index + 1 + sub_index] = (

" " * current_num_of_nested_funcs

) + lines[index + 1 + sub_index]

current_num_of_nested_funcs -= 1

line = line[:bracket_index] + line[bracket_index + 1 :]

if matching_line_index == index:

line = (

line[:matching_char_index]

+ line[matching_char_index + 1 :]

)

else:

tmp_line = lines[matching_line_index]

lines[matching_line_index] = (

tmp_line[:matching_char_index]

+ tmp_line[matching_char_index + 1 :]

)

except Exception as e:

print(

f"An error occurred when processing {in_file}. "

"The closing curly bracket could not be found in "

f"Line {index+1}: {line}. Please reformat the function "

"definition and make sure that both the opening and "

"closing curly brackets appear on the same line as the "

"function keyword."

)

print(e)

return

line = (

line.replace(" = function", "")

.replace("=function", "")

.replace("function ", "")

)

if line.lstrip().startswith("//"):

line = line.replace("//", "").lstrip()

line = (

" " * (len(line) - len(line.lstrip()))

+ "# def "

+ line.strip()

+ ":"

)

else:

line = (

" " * (len(line) - len(line.lstrip()))

+ "def "

+ line.strip()

+ ":"

)

elif "{" in line and "({" not in line:

bracket_index = line.index("{")

(

matching_line_index,

matching_char_index,

) = find_matching_bracket(lines, index, bracket_index)

current_num_of_nested_funcs += 1

for sub_index, tmp_line in enumerate(

lines[index + 1 : matching_line_index]

):

lines[index + 1 + sub_index] = (

" " * current_num_of_nested_funcs

) + lines[index + 1 + sub_index]

if "{" in tmp_line and "if" not in line and "for" not in line:

current_num_of_nested_funcs += 1

if "}" in tmp_line and "if" not in line and "for" not in line:

current_num_of_nested_funcs -= 1

current_num_of_nested_funcs -= 1

if (matching_line_index == index) and (":" in line):

pass

elif (

("for (" in line)

or ("for(" in line)

or ("if (" in line)

or ("if(" in line)

):

if "if" not in line:

line = convert_for_loop(line)

else:

start_index = line.index("(")

end_index = line.index(")")

line = "if " + line[start_index:end_index] + "):{"

lines[index] = line

bracket_index = line.index("{")

(

matching_line_index,

matching_char_index,

) = find_matching_bracket(lines, index, bracket_index)

tmp_line = lines[matching_line_index]

lines[matching_line_index] = (

tmp_line[:matching_char_index]

+ tmp_line[matching_char_index + 1 :]

)

line = line.replace("{", "")

if line is None:

line = ""

line = line.replace("//", "#")

line = line.replace("var ", "", 1)

line = line.replace("/*", "#")

line = line.replace("*/", "#")

line = line.replace("true", "True").replace("false", "False")

line = line.replace("null", "None")

line = line.replace(".or", ".Or")

line = line.replace(".and", ".And")

line = line.replace(".not", ".Not")

line = line.replace("visualize({", "visualize(**{")

line = line.replace("Math.PI", "math.pi")

line = line.replace("Math.", "math.")

line = line.replace("parseInt", "int")

line = line.replace("NotNull", "notNull")

line = line.replace("= new", "=")

line = line.replace("exports.", "")

line = line.replace("Map.", f"{Map}.")

line = line.replace(

"Export.table.toDrive", "geemap.ee_export_vector_to_drive"

)

line = line.replace(

"Export.table.toAsset", "geemap.ee_export_vector_to_asset"

)

line = line.replace(

"Export.image.toAsset", "geemap.ee_export_image_to_asset"

)

line = line.replace(

"Export.video.toDrive", "geemap.ee_export_video_to_drive"

)

line = line.replace("||", "or")

line = line.replace(r"\****", "#")

line = line.replace("def =", "_def =")

line = line.replace(", def, ", ", _def, ")

line = line.replace("(def, ", "(_def, ")

line = line.replace(", def)", ", _def)")

line = line.replace("===", "==")

# Replaces all javascript operators with python operators.

if "!" in line:

try:

if (line.replace(" ", ""))[line.find("!") + 1] != "=":

line = line.replace("!", "not ")

except:

print("continue...")

line = line.rstrip()

# If the function concat is used, replace it with python's

# concatenation.

if "concat" in line:

line = line.replace(".concat(", "+")

line = line.replace(",", "+")

line = line.replace(")", "")

# Checks if an equal sign is at the end of a line. If so, add

# backslashes.

if should_check_for_empty_lines:

if line.strip() == "" or "#" in line:

if line.strip().endswith("["):

line = "["

should_check_for_empty_lines = False

else:

line = "\\"

else:

should_check_for_empty_lines = False

if line.strip().endswith("="):

line = line + " \\"

should_check_for_empty_lines = True

# Adds getInfo at the end of print statements involving maps

end_of_print_replaced = False

if ("print(" in line and "=" not in line) or check_next_line_for_print:

for i in range(len(line) - 1):

if line[len(line) - i - 1] == ")":

line = line[: len(line) - i - 1] + ".getInfo())"

# print(line)

end_of_print_replaced = True

break

if end_of_print_replaced:

check_next_line_for_print = False

else:

check_next_line_for_print = True

# Removes potential commas after imports. Causes tuple type errors.

if line.endswith(","):

if "=" in lines[index + 1] and not lines[

index + 1

].strip().startswith("'"):

line = line[:-1]

# Changes object argument to individual parameters.

if (

line.strip().endswith("({")

and not "ee.Dictionary" in line

and not ".set(" in line

and ".addLayer" not in line

and "cast" not in line

):

line = line.rstrip()[:-1]

num_incorrect_parameters = num_incorrect_parameters + 1

if num_incorrect_parameters > 0:

if line.strip().startswith("})"):

line = line.replace("})", ")")

num_incorrect_parameters = num_incorrect_parameters - 1

else:

if current_dictionary_scope_depth < 1:

line = line.replace(": ", "=")

line = line.replace(":", " =")

if "= {" in line and "({" not in line:

current_dictionary_scope_depth += 1

if "}" in line and current_dictionary_scope_depth > 0:

current_dictionary_scope_depth -= 1

if line.endswith("+"):

line = line + " \\"

elif line.endswith(";"):

line = line[:-1]

if line.lstrip().startswith("*"):

line = line.replace("*", "#")

if (

(":" in line)

and (not line.strip().startswith("#"))

and (not line.strip().startswith("def"))

and (not line.strip().startswith("."))

and (not line.strip().startswith("if"))

):

line = format_params(line)

if (

index < (len(lines) - 1)

and line.lstrip().startswith("#")

and lines[index + 1].lstrip().startswith(".")

):

line = ""

if (

"#" in line

and not line.strip().startswith("#")

and not line[line.index("#") - 1] == "'"

):

line = line[: line.index("#")]

if line.lstrip().startswith("."):

if lines[index - 1].strip().endswith("\\") and lines[

index - 1

].strip().startswith("#"):

lines[index - 1] = "\\"

if "#" in line:

line = line[: line.index("#")]

output = output.rstrip() + " " + "\\" + "\n" + line + "\n"

else:

output += line + "\n"

if show_map:

output += Map

out_dir = os.path.dirname(out_file)

if not os.path.exists(out_dir):

os.makedirs(out_dir)

with open(out_file, "w", encoding="utf-8") as f:

f.write(output)

"""Create a new cell in Jupyter notebook based on the contents.

shell = get_ipython()

in_js_snippet: str,

add_new_cell: bool = True,

import_ee: bool = True,

import_geemap: bool = False,

show_map: bool = True,

Map: str = "m",

) -> list[str] | None:

"""EE JavaScript snippet wrapped in triple quotes to Python in a notebook.

in_js = coreutils.temp_file_path(".js")

out_py = coreutils.temp_file_path(".py")

# Add quotes around keys.

in_js_snippet = re.sub(r"([a-zA-Z0-9_]+)\s*:", r'"\1":', in_js_snippet)

with open(in_js, "w", encoding="utf-8") as f:

f.write(in_js_snippet)

js_to_python(

in_js,

out_file=out_py,

use_qgis=False,

show_map=show_map,

import_geemap=import_geemap,

Map=Map,

)

out_lines = []

if import_ee:

out_lines.append("import ee\n")

with open(out_py, encoding="utf-8") as f:

lines = f.readlines()

for index, line in enumerate(lines):

if index < (len(lines) - 1):

if line.strip() == "import ee":

continue

next_line = lines[index + 1]

if line.strip() == "" and next_line.strip() == "":

continue

if ".style(" in line and (".style(**" not in line):

line = line.replace(".style(", ".style(**")

out_lines.append(line)

elif "({" in line:

line = line.replace("({", "(**{")

out_lines.append(line)

else:

out_lines.append(line)

elif index == (len(lines) - 1) and lines[index].strip() != "":

out_lines.append(line)

os.remove(in_js)

os.remove(out_py)

if add_new_cell:

contents = "".join(out_lines).strip()

create_new_cell(contents)

else:

in_dir: str,

out_dir: str | None = None,

use_qgis: bool = True,

github_repo: str | None = None,

import_geemap: bool = False,

Map: str = "m",

) -> None:

"""Converts EE JavaScript files in a folder recursively to Python scripts.

print("Converting Earth Engine JavaScripts to Python scripts...")

in_dir = os.path.abspath(in_dir)

if out_dir is None:

out_dir = in_dir

elif not os.path.exists(out_dir):

out_dir = os.path.abspath(out_dir)

os.makedirs(out_dir)

else:

out_dir = os.path.abspath(out_dir)

files = list(pathlib.Path(in_dir).rglob("*.js"))

for index, in_file in enumerate(files):

print(f"Processing {index + 1}/{len(files)}: {in_file}")

out_file = os.path.splitext(in_file)[0] + "_geemap.py"

out_file = out_file.replace(in_dir, out_dir)

js_to_python( # pytype: disable=wrong-arg-types

in_file, # pyrefly: ignore[bad-argument-type]

out_file,

use_qgis,

github_repo,

import_geemap=import_geemap,

Map=Map,

"""Removes 'from ee_plugin import Map' from an Earth Engine Python file.

in_file = os.path.abspath(in_file)

with open(in_file, encoding="utf-8") as f:

lines = f.readlines()

for index, line in enumerate(lines):

if "from ee_plugin import Map" in line:

start_index = index

i = 1

while True:

line_tmp = lines[start_index + i].strip()

if line_tmp != "":

return lines[start_index + i :]

i = i + 1

elif f"{Map} = geemap.Map()" in line:

"""Gets Earth Engine JavaScript examples from the geemap package.

pkg_dir = pathlib.Path(__file__).parent

example_dir = pkg_dir / "data"

js_dir = example_dir / "javascripts"

files = list(js_dir.rglob("*.js"))

if out_dir is None:

out_dir = js_dir # pyrefly: ignore[bad-assignment]

else:

assert isinstance(out_dir, pathlib.Path)

out_dir.mkdir(parent=True, exist_ok=True)

for file in files:

out_path = out_dir / file.name

shutil.copyfile(file, out_path)

download_latest: bool = False, out_file: pathlib.Path | None = None

) -> pathlib.Path:

"""Get the Earth Engine Jupyter notebook template.

pkg_dir = pathlib.Path(__file__).parent

example_dir = pkg_dir / "data"

template_dir = example_dir / "template"

template_file = template_dir / "template.py"

if out_file is None:

out_file = template_file

return out_file

out_file = out_file.with_suffix(".py")

out_file.parent.mkdir(parents=True, exist_ok=True)

if download_latest:

template_url = (

"https://raw.githubusercontent.com/gee-community/geemap/master/"

"examples/template/template.py"

)

print(f"Downloading the latest notebook template from {template_url}")

urllib.request.urlretrieve(template_url, out_file)

elif out_file is not None:

shutil.copyfile(template_file, out_file)

"""Extracts header from the notebook template.

header_end_index = 0

with open(in_template, encoding="utf-8") as f:

template_lines = f.readlines()

for index, line in enumerate(template_lines):

if "## Add Earth Engine Python script" in line:

header_end_index = index + 6

header = template_lines[:header_end_index]

"""Extracts footer from the notebook template.

footer_start_index = 0

with open(in_template, encoding="utf-8") as f:

template_lines = f.readlines()

for index, line in enumerate(template_lines):

if "## Display the interactive map" in line:

footer_start_index = index - 2