※この翻訳ドキュメントはスクリプトによって出力・同期されています。内容が怪しそうな場合はGitHubにissueを追加したり英語の原文の確認をお願いします。

String クラスの lstrip インターフェイス

このページではStringクラスのlstripメソッドのインターフェイスについて説明します。

インターフェイス概要

lstripメソッドのインターフェイスは文字列の左端から空白文字もしくは指定された文字（もしくは文字列）を取り除きます。

基本的な使い方

lstripメソッドは省略可能なstring引数を受け付けます。

もしもこの引数の指定を省略した場合、このインターフェイスは空白文字（スペースや改行など）を文字列の左端から取り除きます。

import apysc as ap

ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)

string: ap.String = ap.String("  
　 aabbaa  ")
string = string.lstrip()
ap.assert_equal(string, "aabbaa  ")

ap.save_overall_html(dest_dir_path="string_lstrip_basic_usage_1/")

また、もしも何らかの文字列の値をstring引数に指定した場合、このインターフェイスは文字列の左端からその文字（もしくは文字列）を取り除きます。

import apysc as ap

ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)

string: ap.String = ap.String("aabbaa")
string = string.lstrip(string="a")
ap.assert_equal(string, "bbaa")

ap.save_overall_html(dest_dir_path="string_lstrip_basic_usage_2/")

lstrip API

特記事項: このAPIドキュメントはドキュメントビルド用のスクリプトによって自動で生成・同期されています。そのためもしかしたらこの節の内容は前節までの内容と重複している場合があります。

[インターフェイスの構造] lstrip(self, *, string: Union[str, ForwardRef('String'), NoneType] = None, variable_name_suffix: str = '') -> 'String'

[インターフェイス概要]

この値の左端から指定された文字もしく文字列を取り除きます。

[引数]

  • string: Optional[Union[str, “String”]], optional

    • この値の左端から取り除く文字もしくは文字列。もしもこの引数がの値がNone（デフォルト）だった場合、このメソッドはスペースや改行などを取り除きます。

  • variable_name_suffix: str, optional

    • JavaScript上の変数のサフィックスの設定です。この設定はJavaScriptのデバッグ時に役立つことがあります。

[返却値]

  • result: String

    • 除外処理実行後の文字列。

[コードサンプル]

>>> import apysc as ap
>>> _ = ap.Stage()
>>> string: ap.String = ap.String("   aabbcc  ")
>>> string = string.lstrip()
>>> string
String("aabbcc  ")

>>> string = ap.String("aabbccaa")
>>> string = string.lstrip(string="a")
>>> string
String("bbccaa")