Locale ko_KR¶
faker.providers.address
¶
-
class
faker.providers.address.ko_KR.
Provider
(generator: Any)¶ Bases:
faker.providers.address.Provider
Korea has two address and postal code system.
- Address:
- Address based on land parcel numbers (지번 주소, OLD, but someone use consistently)
- Address based on road names and building numbers (도로명 주소, NEW)
land_address()
generate Address based on land parcel numbers androad_address()
generate Address based on road names and building numbers.- Postal code:
- Old postal code (6-digit, OLD and dead)
- New postal code (5-digit, New)
old_postal_code()
andpostcode()
generate old 6-digit code andpostal_code()
generate newer 5-digit code.- Reference:
- Official Confirmation Prividing that Old and New Addresses are Identical (warn: cert error)
-
address
() → str¶ Example: ‘791 Crist Parks, Sashabury, IL 86039-9874’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.address() ... '경상북도 성남시 서초대64가 (서윤백박면)' '강원도 부여군 잠실924로' '대전광역시 강서구 영동대가' '인천광역시 금천구 반포대408로 (예지이동)' '전라남도 남양주시 학동9길 (은주김마을)'
-
address_detail
() → str¶ Example: 가나아파트 가동 102호 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.address_detail() ... '준호안이마을 604호' '우진권타운 938호' '상철김고연립 892호' '정수윤김타운 815호' '은주최빌라 784호'
-
administrative_unit
() → str¶ Example: 경기도 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.administrative_unit() ... '경상북도' '경상북도' '경기도' '전라북도' '제주특별자치도'
-
borough
() → str¶ Example: 중구 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.borough() ... '남구' '서대문구' '강동구' '북구' '마포구'
-
building_dong
() → str¶ Example: 가 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.building_dong() ... 'Q' 'S' '다' 'I' 'Y'
-
building_name
() → str¶ Example: 김구아파트 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.building_name() ... '유진이김타운' '준호안이마을' '서윤백박연립' '유진강연립' '정남서타워'
-
building_number
() → str¶ Example: ‘791’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.building_number() ... '60' '87' '47' '93' '42'
-
building_suffix
() → str¶ Example: 아파트 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.building_suffix() ... '마을' '마을' '빌라' '연립' '타운'
-
city
() → str¶ Example: 고양시 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.city() ... '의정부시' '음성군' '강릉시' '성남시' '시흥시'
-
city_suffix
() → str¶ Example: ‘town’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.city_suffix() ... '시' '시' '시' '시' '시'
-
country
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.country() ... '슬로베니아' '아일랜드' '나우루' '벨기에' '우크라이나'
-
country_code
(representation: str = 'alpha-2') → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.country_code() ... 'MV' 'PS' 'NL' 'BB' 'IL'
-
current_country
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.current_country() ... 'South Korea' 'South Korea' 'South Korea' 'South Korea' 'South Korea'
-
current_country_code
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.current_country_code() ... 'KR' 'KR' 'KR' 'KR' 'KR'
-
land_address
() → str¶ Example: 세종특별자치시 어진동 507 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.land_address() ... '경상북도 성남시 현숙박허면 593-8' '광주광역시 광진구 수빈김마을 924-11' '경상남도 공주시 정훈이읍 778-40' '부산광역시 송파구 예원안강마을 535-1' '인천광역시 성북구 은주박동 871-4'
-
land_number
() → str¶ Example: 507 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.land_number() ... '604-8' '647-5' '382-42' '948' '924-11'
-
metropolitan_city
() → str¶ Example: 서울특별시 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.metropolitan_city() ... '울산광역시' '울산광역시' '서울특별시' '광주광역시' '세종특별자치시'
-
old_postal_code
() → str¶ Example: 123-456 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.old_postal_code() ... '604-876' '759-382' '219-489' '411-578' '565-938'
-
postal_code
() → str¶ Example: 12345 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.postal_code() ... '60487' '47593' '42194' '41157' '56593'
-
postcode
() → str¶ Example: 12345 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.postcode() ... '60487' '47593' '42194' '41157' '56593'
-
province
() → str¶ Example: 경기도 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.province() ... '경상북도' '경상북도' '경기도' '전라북도' '제주특별자치도'
-
road
() → str¶ Example: 도움5로 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.road() ... '선릉4가' '양재천59길' '양재천길' '백제고분거리' '양재천로'
-
road_address
() → str¶ Example: 세종특별자치시 도움5로 19 (어진동) Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.road_address() ... '경상북도 성남시 서초대64가 (서윤백박면)' '강원도 부여군 잠실924로' '대전광역시 강서구 영동대가' '인천광역시 금천구 반포대408로 (예지이동)' '전라남도 남양주시 학동9길 (은주김마을)'
-
road_name
() → str¶ Example: 압구정 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.road_name() ... '개포' '선릉' '도산대' '강남대' '서초대'
-
road_number
() → str¶ Example: 24 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.road_number() ... '60' '87' '47' '93' '242'
-
road_suffix
() → str¶ Example: 길 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.road_suffix() ... '가' '가' '로' '거리' '가'
-
street_address
() → str¶ Example: ‘791 Crist Parks’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.street_address() ... '경상북도 성남시 서초대64가 (서윤백박면)' '강원도 부여군 잠실924로' '대전광역시 강서구 영동대가' '인천광역시 금천구 반포대408로 (예지이동)' '전라남도 남양주시 학동9길 (은주김마을)'
-
street_name
() → str¶ Example: ‘Crist Parks’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.street_name() ... '선릉' '강남대' '개포' '서초중앙' '석촌호수'
-
street_suffix
() → str¶ Example: ‘Avenue’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.street_suffix() ... '가' '가' '로' '거리' '가'
-
town
() → str¶ Example: 가나동 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.town() ... '유진이김마을' '준호안이리' '서윤백박면' '유진강면' '정남서면'
-
town_suffix
() → str¶ Example: 동 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.town_suffix() ... '리' '리' '동' '면' '마을'
faker.providers.company
¶
-
class
faker.providers.company.ko_KR.
Provider
(generator: Any)¶ Bases:
faker.providers.company.Provider
-
bs
() → str¶ Example: ‘integrate extensible convergence’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.bs() ... '벤치마킹된 플러그 앤 플레이 앱' '간소화된 고운 방법론' '신속한 강력한 시스템' '폭발하는 킬러 생산라인' '엔지니어 전략적 전자화폐'
-
catch_phrase
() → str¶ Example: ‘Robust full-range hub’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.catch_phrase() ... '강력한 다음 세대 분석' '객체 기반의 정적 프로토콜' '안전한 인간자원 프로젝트' '재정렬 환경 친화적 소프트웨어' '강화된 고단계 도전'
-
company
() → str¶ Example: ‘Acme Ltd’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.company() ... '권이김' '이안이' '이손김' '(유) 김' '(유) 민박한'
-
company_suffix
() → str¶ Example: ‘Ltd’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.company_suffix() ... '유한회사' '유한회사' '(주)' '(유)' '유한회사'
-
faker.providers.date_time
¶
-
class
faker.providers.date_time.ko_KR.
Provider
(generator: Any)¶ Bases:
faker.providers.date_time.Provider
-
am_pm
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.am_pm() ... 'AM' 'AM' 'AM' 'AM' 'AM'
-
century
() → str¶ Example: ‘XVII’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.century() ... 'XIII' 'XIV' 'II' 'IX' 'XVII'
-
date
(pattern: str = '%Y-%m-%d', end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → str¶ Get a date string between January 1, 1970 and now.
Parameters: pattern – Format of the date (year-month-day by default) Example: ‘2008-11-27’ Returns: Date Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date() ... '1996-03-20' '2021-07-31' '1998-08-15' '1972-10-03' '1987-08-15'
-
date_between
(start_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '-30y', end_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = 'today') → datetime.date¶ Get a Date object based on a random date between two given dates. Accepts date strings that can be recognized by strtotime().
Parameters: - start_date – Defaults to 30 years ago
- end_date – Defaults to “today”
Example: Date(‘1999-02-02’)
Returns: Date
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_between() ... datetime.date(2022, 4, 3) datetime.date(2006, 8, 18) datetime.date(2019, 4, 24) datetime.date(2007, 10, 31) datetime.date(1994, 11, 25)
-
date_between_dates
(date_start: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None, date_end: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → datetime.date¶ Takes two Date objects and returns a random date between the two given dates. Accepts Date or datetime objects
Parameters: - date_start – Date
- date_end – Date
Returns: Date
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_between_dates() ... datetime.date(2023, 7, 11) datetime.date(2023, 7, 11) datetime.date(2023, 7, 11) datetime.date(2023, 7, 11) datetime.date(2023, 7, 11)
-
date_object
(end_datetime: Optional[datetime.datetime] = None) → datetime.date¶ Get a date object between January 1, 1970 and now
Example: datetime.date(2016, 9, 20) Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_object() ... datetime.date(1996, 3, 20) datetime.date(2021, 7, 31) datetime.date(1998, 8, 15) datetime.date(1972, 10, 3) datetime.date(1987, 8, 15)
-
date_of_birth
(tzinfo: Optional[datetime.tzinfo] = None, minimum_age: int = 0, maximum_age: int = 115) → datetime.date¶ Generate a random date of birth represented as a Date object, constrained by optional miminimum_age and maximum_age parameters.
Parameters: - tzinfo – Defaults to None.
- minimum_age – Defaults to 0.
- maximum_age – Defaults to 115.
Example: Date(‘1979-02-02’)
Returns: Date
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_of_birth() ... datetime.date(2022, 6, 13) datetime.date(1959, 12, 15) datetime.date(2010, 9, 6) datetime.date(1964, 10, 5) datetime.date(1913, 1, 12)
-
date_this_century
(before_today: bool = True, after_today: bool = False) → datetime.date¶ Gets a Date object for the current century.
Parameters: - before_today – include days in current century before today
- after_today – include days in current century after today
Example: Date(‘2012-04-04’)
Returns: Date
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_this_century() ... datetime.date(2013, 2, 8) datetime.date(2014, 4, 23) datetime.date(2001, 5, 18) datetime.date(2008, 10, 22) datetime.date(2017, 5, 24)
-
date_this_decade
(before_today: bool = True, after_today: bool = False) → datetime.date¶ Gets a Date object for the decade year.
Parameters: - before_today – include days in current decade before today
- after_today – include days in current decade after today
Example: Date(‘2012-04-04’)
Returns: Date
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_this_decade() ... datetime.date(2021, 8, 21) datetime.date(2023, 3, 23) datetime.date(2021, 10, 15) datetime.date(2020, 3, 3) datetime.date(2021, 2, 6)
-
date_this_month
(before_today: bool = True, after_today: bool = False) → datetime.date¶ Gets a Date object for the current month.
Parameters: - before_today – include days in current month before today
- after_today – include days in current month after today
Example: dtdate(‘2012-04-04’)
Returns: dtdate
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_this_month() ... datetime.date(2023, 7, 5) datetime.date(2023, 7, 10) datetime.date(2023, 7, 6) datetime.date(2023, 7, 1) datetime.date(2023, 7, 4)
-
date_this_year
(before_today: bool = True, after_today: bool = False) → datetime.date¶ Gets a Date object for the current year.
Parameters: - before_today – include days in current year before today
- after_today – include days in current year after today
Example: Date(‘2012-04-04’)
Returns: Date
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_this_year() ... datetime.date(2023, 6, 13) datetime.date(2023, 3, 16) datetime.date(2023, 5, 28) datetime.date(2023, 6, 22) datetime.date(2023, 3, 23)
-
date_time
(tzinfo: Optional[datetime.tzinfo] = None, end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → datetime.datetime¶ Get a datetime object for a date between January 1, 1970 and now
Parameters: tzinfo – timezone, instance of datetime.tzinfo subclass Example: datetime(‘2005-08-16 20:39:21’) Returns: datetime Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time() ... datetime.datetime(1996, 3, 20, 7, 46, 39) datetime.datetime(2021, 7, 31, 1, 24, 38) datetime.datetime(1998, 8, 15, 8, 43, 22) datetime.datetime(1972, 10, 3, 5, 52, 26) datetime.datetime(1987, 8, 15, 9, 51, 25)
-
date_time_ad
(tzinfo: Optional[datetime.tzinfo] = None, end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None, start_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → datetime.datetime¶ Get a datetime object for a date between January 1, 001 and now
Parameters: tzinfo – timezone, instance of datetime.tzinfo subclass Example: datetime(‘1265-03-22 21:15:52’) Returns: datetime Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_ad() ... datetime.datetime(932, 7, 17, 1, 20, 13) datetime.datetime(2009, 8, 3, 21, 25) datetime.datetime(58, 3, 29, 17, 26, 45) datetime.datetime(1023, 4, 21, 11, 47, 46) datetime.datetime(1961, 7, 18, 3, 50, 16)
-
date_time_between
(start_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '-30y', end_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = 'now', tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime¶ Get a datetime object based on a random date between two given dates. Accepts date strings that can be recognized by strtotime().
Parameters: - start_date – Defaults to 30 years ago
- end_date – Defaults to “now”
- tzinfo – timezone, instance of datetime.tzinfo subclass
Example: datetime(‘1999-02-02 11:42:52’)
Returns: datetime
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_between() ... datetime.datetime(2022, 4, 4, 16, 11, 19) datetime.datetime(2006, 8, 20, 5, 26, 59) datetime.datetime(2019, 4, 26, 2, 15, 59) datetime.datetime(2007, 11, 2, 5, 55, 21) datetime.datetime(1994, 11, 26, 16, 29, 53)
-
date_time_between_dates
(datetime_start: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None, datetime_end: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None, tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime¶ Takes two datetime objects and returns a random datetime between the two given datetimes. Accepts datetime objects.
Parameters: - datetime_start – datetime
- datetime_end – datetime
- tzinfo – timezone, instance of datetime.tzinfo subclass
Example: datetime(‘1999-02-02 11:42:52’)
Returns: datetime
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_between_dates() ... datetime.datetime(2023, 7, 11, 18, 21, 40) datetime.datetime(2023, 7, 11, 18, 21, 40) datetime.datetime(2023, 7, 11, 18, 21, 40) datetime.datetime(2023, 7, 11, 18, 21, 40) datetime.datetime(2023, 7, 11, 18, 21, 40)
-
date_time_this_century
(before_now: bool = True, after_now: bool = False, tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime¶ Gets a datetime object for the current century.
Parameters: - before_now – include days in current century before today
- after_now – include days in current century after today
- tzinfo – timezone, instance of datetime.tzinfo subclass
Example: datetime(‘2012-04-04 11:02:02’)
Returns: datetime
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_this_century() ... datetime.datetime(2013, 2, 8, 15, 53, 19) datetime.datetime(2014, 4, 23, 16, 21, 41) datetime.datetime(2001, 5, 18, 2, 56, 13) datetime.datetime(2008, 10, 22, 16, 55, 42) datetime.datetime(2017, 5, 24, 21, 37, 28)
-
date_time_this_decade
(before_now: bool = True, after_now: bool = False, tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime¶ Gets a datetime object for the decade year.
Parameters: - before_now – include days in current decade before today
- after_now – include days in current decade after today
- tzinfo – timezone, instance of datetime.tzinfo subclass
Example: datetime(‘2012-04-04 11:02:02’)
Returns: datetime
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_this_decade() ... datetime.datetime(2021, 8, 21, 10, 59, 9) datetime.datetime(2023, 3, 23, 10, 35, 17) datetime.datetime(2021, 10, 15, 8, 2, 42) datetime.datetime(2020, 3, 3, 21, 22, 1) datetime.datetime(2021, 2, 6, 5, 6, 57)
-
date_time_this_month
(before_now: bool = True, after_now: bool = False, tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime¶ Gets a datetime object for the current month.
Parameters: - before_now – include days in current month before today
- after_now – include days in current month after today
- tzinfo – timezone, instance of datetime.tzinfo subclass
Example: datetime(‘2012-04-04 11:02:02’)
Returns: datetime
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_this_month() ... datetime.datetime(2023, 7, 11, 5, 57, 20) datetime.datetime(2023, 7, 5, 16, 12, 38) datetime.datetime(2023, 7, 10, 4, 46, 12) datetime.datetime(2023, 7, 6, 2, 30, 1) datetime.datetime(2023, 7, 1, 11, 47, 30)
-
date_time_this_year
(before_now: bool = True, after_now: bool = False, tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime¶ Gets a datetime object for the current year.
Parameters: - before_now – include days in current year before today
- after_now – include days in current year after today
- tzinfo – timezone, instance of datetime.tzinfo subclass
Example: datetime(‘2012-04-04 11:02:02’)
Returns: datetime
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_this_year() ... datetime.datetime(2023, 6, 13, 23, 17, 27) datetime.datetime(2023, 3, 16, 19, 22, 23) datetime.datetime(2023, 5, 28, 4, 19, 24) datetime.datetime(2023, 6, 22, 20, 50, 14) datetime.datetime(2023, 3, 23, 16, 0, 20)
-
day_of_month
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.day_of_month() ... '20' '31' '15' '03' '15'
-
day_of_week
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.day_of_week() ... '수요일' '토요일' '토요일' '화요일' '토요일'
-
future_date
(end_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '+30d', tzinfo: Optional[datetime.tzinfo] = None) → datetime.date¶ Get a Date object based on a random date between 1 day from now and a given date. Accepts date strings that can be recognized by strtotime().
Parameters: - end_date – Defaults to “+30d”
- tzinfo – timezone, instance of datetime.tzinfo subclass
Example: dtdate(‘2030-01-01’)
Returns: dtdate
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.future_date() ... datetime.date(2023, 7, 30) datetime.date(2023, 8, 1) datetime.date(2023, 7, 13) datetime.date(2023, 7, 24) datetime.date(2023, 8, 5)
-
future_datetime
(end_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '+30d', tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime¶ Get a datetime object based on a random date between 1 second form now and a given date. Accepts date strings that can be recognized by strtotime().
Parameters: - end_date – Defaults to “+30d”
- tzinfo – timezone, instance of datetime.tzinfo subclass
Example: datetime(‘1999-02-02 11:42:52’)
Returns: datetime
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.future_datetime() ... datetime.datetime(2023, 7, 30, 11, 12, 16) datetime.datetime(2023, 8, 1, 4, 21, 46) datetime.datetime(2023, 7, 13, 17, 31, 44) datetime.datetime(2023, 7, 24, 8, 1, 16) datetime.datetime(2023, 8, 5, 14, 2, 22)
-
iso8601
(tzinfo: Optional[datetime.tzinfo] = None, end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None, sep: str = 'T', timespec: str = 'auto') → str¶ Get a timestamp in ISO 8601 format (or one of its profiles).
Parameters: - tzinfo – timezone, instance of datetime.tzinfo subclass
- sep – separator between date and time, defaults to ‘T’
- timespec – format specifier for the time part, defaults to ‘auto’ - see datetime.isoformat() documentation
Example: ‘2003-10-21T16:05:52+0000’
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.iso8601() ... '1996-03-20T07:46:39' '2021-07-31T01:24:38' '1998-08-15T08:43:22' '1972-10-03T05:52:26' '1987-08-15T09:51:25'
-
month
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.month() ... '03' '07' '08' '10' '08'
-
month_name
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.month_name() ... '3월' '7월' '8월' '10월' '8월'
-
past_date
(start_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '-30d', tzinfo: Optional[datetime.tzinfo] = None) → datetime.date¶ Get a Date object based on a random date between a given date and 1 day ago. Accepts date strings that can be recognized by strtotime().
Parameters: - start_date – Defaults to “-30d”
- tzinfo – timezone, instance of datetime.tzinfo subclass
Example: dtdate(‘1999-02-02’)
Returns: dtdate
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.past_date() ... datetime.date(2023, 6, 29) datetime.date(2023, 7, 1) datetime.date(2023, 6, 12) datetime.date(2023, 6, 23) datetime.date(2023, 7, 5)
-
past_datetime
(start_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '-30d', tzinfo: Optional[datetime.tzinfo] = None) → datetime.datetime¶ Get a datetime object based on a random date between a given date and 1 second ago. Accepts date strings that can be recognized by strtotime().
Parameters: - start_date – Defaults to “-30d”
- tzinfo – timezone, instance of datetime.tzinfo subclass
Example: datetime(‘1999-02-02 11:42:52’)
Returns: datetime
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.past_datetime() ... datetime.datetime(2023, 6, 30, 11, 12, 15) datetime.datetime(2023, 7, 2, 4, 21, 45) datetime.datetime(2023, 6, 13, 17, 31, 43) datetime.datetime(2023, 6, 24, 8, 1, 15) datetime.datetime(2023, 7, 6, 14, 2, 21)
-
pytimezone
(*args, **kwargs) → Optional[datetime.tzinfo]¶ Generate a random timezone (see faker.timezone for any args) and return as a python object usable as a tzinfo to datetime or other fakers.
Example: faker.pytimezone() Returns: dateutil.tz.tz.tzfile Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.pytimezone() ... tzfile('/usr/share/zoneinfo/Indian/Maldives') tzfile('/usr/share/zoneinfo/America/Barbados') tzfile('/usr/share/zoneinfo/Europe/Stockholm') tzfile('/usr/share/zoneinfo/Africa/Windhoek') tzfile('/usr/share/zoneinfo/Asia/Qatar')
-
time
(pattern: str = '%H:%M:%S', end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → str¶ Get a time string (24h format by default)
Parameters: pattern – format Example: ‘15:02:34’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.time() ... '07:46:39' '01:24:38' '08:43:22' '05:52:26' '09:51:25'
-
time_delta
(end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → datetime.timedelta¶ Get a timedelta object
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.time_delta() ... datetime.timedelta(0) datetime.timedelta(0) datetime.timedelta(0) datetime.timedelta(0) datetime.timedelta(0)
-
time_object
(end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → datetime.time¶ Get a time object
Example: datetime.time(15, 56, 56, 772876) Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.time_object() ... datetime.time(7, 46, 39) datetime.time(1, 24, 38) datetime.time(8, 43, 22) datetime.time(5, 52, 26) datetime.time(9, 51, 25)
-
time_series
(start_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = '-30d', end_date: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int] = 'now', precision: Optional[float] = None, distrib: Optional[Callable[[datetime.datetime], float]] = None, tzinfo: Optional[datetime.tzinfo] = None) → Iterator[Tuple[datetime.datetime, Any]]¶ Returns a generator yielding tuples of
(<datetime>, <value>)
.The data points will start at
start_date
, and be at every time interval specified byprecision
.distrib
is a callable that accepts<datetime>
and returns<value>
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.time_series() ... <generator object Provider.time_series at 0x7f0d853245d0> <generator object Provider.time_series at 0x7f0d853245d0> <generator object Provider.time_series at 0x7f0d853245d0> <generator object Provider.time_series at 0x7f0d853245d0> <generator object Provider.time_series at 0x7f0d853245d0>
-
timezone
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.timezone() ... 'Indian/Maldives' 'America/Barbados' 'Europe/Stockholm' 'Africa/Windhoek' 'Asia/Qatar'
-
unix_time
(end_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None, start_datetime: Union[datetime.date, datetime.datetime, datetime.timedelta, str, int, None] = None) → int¶ Get a timestamp between January 1, 1970 and now, unless passed explicit start_datetime or end_datetime values.
Example: 1061306726 Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.unix_time() ... 827307999 1627694678 903170602 86939546 556019485
-
year
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.year() ... '1996' '2021' '1998' '1972' '1987'
-
faker.providers.internet
¶
-
class
faker.providers.internet.ko_KR.
Provider
(generator: Any)¶ Bases:
faker.providers.internet.Provider
-
ascii_company_email
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.ascii_company_email() ... 'agweon@yu.org' 'hyeonjeong59@jusighoesa.org' 'gangyeongceol@yu.com' 'gyeongja15@iyungim.kr' 'hbag@gimheo.com'
-
ascii_email
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.ascii_email() ... 'ggim@dreamwiz.com' 'hyeonjeong59@hanmail.net' 'seongmin19@minbag.net' 'sangceol15@coeii.net' 'hbag@gimheo.com'
-
ascii_free_email
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.ascii_free_email() ... 'agweon@gmail.com' 'hyeonsug76@naver.com' 'ni@hotmail.com' 'seongmin19@naver.com' 'jeongnamseo@nate.com'
-
ascii_safe_email
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.ascii_safe_email() ... 'agweon@example.org' 'hyeonsug76@example.com' 'ni@example.net' 'ujingweon@example.net' 'hyeonji89@example.org'
-
company_email
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.company_email() ... 'agweon@yu.org' 'hyeonjeong59@jusighoesa.org' 'gangyeongceol@yu.com' 'gyeongja15@iyungim.kr' 'hbag@gimheo.com'
-
dga
(year: Optional[int] = None, month: Optional[int] = None, day: Optional[int] = None, tld: Optional[str] = None, length: Optional[int] = None) → str¶ Generates a domain name by given date https://en.wikipedia.org/wiki/Domain_generation_algorithm
Return type: str Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.dga() ... 'hxqvaffcmfsccynscisxeajjagjahtnfcmfsccynscisxeajjagjahtnfcmfscc.com' 'meydkrgdcvulautulqvjofrrnbjkfmvrewtpfttqcjafdhxckmyfamo.org' 'rsoitciyjatufbjfquyfvudjerivnsrsprechaalfphoqywwursulakiudm.kr' 'ujkyfemsyj.com' 'yastipdtwjouhjjorvdtvxkkhdirblaoisavobsvdnhimwbflybiwimdljso.com'
-
domain_name
(levels: int = 1) → str¶ Produce an Internet domain name with the specified number of subdomain levels.
>>> domain_name() nichols-phillips.com >>> domain_name(2) williamson-hopkins.jackson.com
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.domain_name() ... 'gweonigim.kr' 'iani.kr' 'coebaeg.kr' 'yu.com' 'minbag.net'
-
domain_word
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.domain_word() ... 'gweonigim' 'iani' 'isongim' 'yu' 'yu'
-
email
(safe: bool = True, domain: Optional[str] = None) → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.email() ... 'agweon@example.org' 'hyeonsug76@example.com' 'ni@example.net' 'ujingweon@example.net' 'hyeonji89@example.org'
-
free_email
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.free_email() ... 'agweon@gmail.com' 'hyeonsug76@naver.com' 'ni@hotmail.com' 'seongmin19@naver.com' 'jeongnamseo@nate.com'
-
free_email_domain
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.free_email_domain() ... 'live.com' 'live.com' 'gmail.com' 'naver.com' 'dreamwiz.com'
-
hostname
(levels: int = 1) → str¶ Produce a hostname with specified number of subdomain levels.
>>> hostname() db-01.nichols-phillips.com >>> hostname(0) laptop-56 >>> hostname(2) web-12.williamson-hopkins.jackson.com
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.hostname() ... 'web-66.yu.org' 'desktop-75.jusighoesa.org' 'db-94.yu.com' 'web-57.yu.kr' 'laptop-78.gimheo.com'
-
http_method
() → str¶ Returns random HTTP method https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods
Return type: str Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.http_method() ... 'OPTIONS' 'OPTIONS' 'GET' 'DELETE' 'PATCH'
-
iana_id
() → str¶ Returns IANA Registrar ID https://www.iana.org/assignments/registrar-ids/registrar-ids.xhtml
Return type: str Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.iana_id() ... '6463344' '7056021' '679216' '4343903' '8577767'
-
image_url
(width: Optional[int] = None, height: Optional[int] = None, placeholder_url: Optional[str] = None) → str¶ Returns URL to placeholder image Example: http://placehold.it/640x480
Parameters: - width – Optional image width
- height – Optional image height
- placeholder_url – Optional template string of image URLs from custom
placeholder service. String must contain
{width}
and{height}
placeholders, eg:https:/example.com/{width}/{height}
.
Return type: Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.image_url() ... 'https://picsum.photos/788/861' 'https://dummyimage.com/530x995' 'https://dummyimage.com/621x976' 'https://dummyimage.com/447x285' 'https://placekitten.com/286/194'
-
ipv4
(network: bool = False, address_class: Optional[str] = None, private: Optional[str] = None) → str¶ Returns a random IPv4 address or network with a valid CIDR.
Parameters: - network – Network address
- address_class – IPv4 address class (a, b, or c)
- private – Public or private
Returns: IPv4
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.ipv4() ... '171.174.170.81' '95.25.112.121' '51.105.121.194' '195.110.164.126' '141.250.247.54'
-
ipv4_network_class
() → str¶ Returns a IPv4 network class ‘a’, ‘b’ or ‘c’.
Returns: IPv4 network class Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.ipv4_network_class() ... 'b' 'b' 'a' 'b' 'c'
-
ipv4_private
(network: bool = False, address_class: Optional[str] = None) → str¶ Returns a private IPv4.
Parameters: - network – Network address
- address_class – IPv4 address class (a, b, or c)
Returns: Private IPv4
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.ipv4_private() ... '172.29.117.82' '10.248.203.131' '172.25.180.188' '172.22.253.123' '192.168.71.140'
-
ipv4_public
(network: bool = False, address_class: Optional[str] = None) → str¶ Returns a public IPv4 excluding private blocks.
Parameters: - network – Network address
- address_class – IPv4 address class (a, b, or c)
Returns: Public IPv4
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.ipv4_public() ... '166.186.169.69' '111.198.92.30' '168.155.75.206' '141.250.247.54' '212.120.204.37'
-
ipv6
(network: bool = False) → str¶ Produce a random IPv6 address or network with a valid CIDR
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.ipv6() ... 'e3e7:682:c209:4cac:629f:6fbf:d82c:7cd' 'f728:b4fa:4248:5e3a:a5d:2f35:6baa:9455' 'eb11:67b3:67a9:c378:7c65:c1e6:82e2:e662' 'f7c1:bd87:4da5:e709:d471:3d61:c8a7:639' 'e443:df78:9558:867f:5ba9:1fb0:7a02:4204'
-
mac_address
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.mac_address() ... 'c5:d7:14:84:f8:cf' '9b:f4:b7:6f:47:90' '47:30:80:4b:9e:32' '25:a9:f1:33:b5:de' 'a1:68:f4:e2:85:1f'
-
nic_handle
(suffix: str = 'FAKE') → str¶ Returns NIC Handle ID https://www.apnic.net/manage-ip/using-whois/guide/person/
Return type: str Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.nic_handle() ... 'ZYT1598-FAKE' 'SIW493-FAKE' 'UE59352-FAKE' 'WBUN892-FAKE' 'CHQD98-FAKE'
-
nic_handles
(count: int = 1, suffix: str = '????') → List[str]¶ Returns NIC Handle ID list
Return type: list[str] Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.nic_handles() ... ['ZYT1598-EWLN'] ['WGNZ53-QITZ'] ['UERV52-EJGW'] ['CHQ498-DZJA'] ['UU1864-TEMK']
-
port_number
(is_system: bool = False, is_user: bool = False, is_dynamic: bool = False) → int¶ Returns a network port number https://tools.ietf.org/html/rfc6335
Parameters: - is_system – System or well-known ports
- is_user – User or registered ports
- is_dynamic – Dynamic / private / ephemeral ports
Return type: Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.port_number() ... 50494 55125 5306 33936 63691
-
ripe_id
() → str¶ Returns RIPE Organization ID https://www.ripe.net/manage-ips-and-asns/db/support/organisation-object-in-the-ripe-database
Return type: str Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.ripe_id() ... 'ORG-ZYT1598-RIPE' 'ORG-SIW493-RIPE' 'ORG-UE59352-RIPE' 'ORG-WBUN892-RIPE' 'ORG-CHQD98-RIPE'
-
safe_domain_name
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.safe_domain_name() ... 'example.com' 'example.com' 'example.org' 'example.com' 'example.net'
-
safe_email
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.safe_email() ... 'agweon@example.org' 'hyeonsug76@example.com' 'ni@example.net' 'ujingweon@example.net' 'hyeonji89@example.org'
-
slug
(value: Optional[str] = None) → str¶ Django algorithm
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.slug() ... 'molestiae-nihil' 'facilis-quaerat' 'necessitatibus' 'perferendis-magnam' 'esse-quae-deserunt'
-
tld
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.tld() ... 'org' 'kr' 'org' 'kr' 'com'
-
uri
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.uri() ... 'https://www.cabag.org/explore/category/main/' 'http://ju.com/explore/posts/list/post.html' 'https://yu.kr/' 'https://ju.org/tags/tags/posts/homepage/' 'https://www.jusighoesa.com/privacy/'
-
uri_extension
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.uri_extension() ... '.php' '.php' '.html' '.htm' '.asp'
-
uri_page
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.uri_page() ... 'author' 'category' 'privacy' 'category' 'index'
-
uri_path
(deep: Optional[int] = None) → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.uri_path() ... 'posts/tag' 'explore/tag' 'explore/category' 'blog' 'category'
-
url
(schemes: Optional[List[str]] = None) → str¶ Parameters: schemes – a list of strings to use as schemes, one will chosen randomly. If None, it will generate http and https urls. Passing an empty list will result in schemeless url generation like “://domain.com”. Returns: a random url string. Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.url() ... 'https://yu.org/' 'https://coebaeg.kr/' 'http://ju.com/' 'http://ju.com/' 'https://gangbaeg.kr/'
-
user_name
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.user_name() ... 'agweon' 'gimmigyeong' 'theo' 'ni' 'ujingweon'
-
faker.providers.job
¶
-
class
faker.providers.job.ko_KR.
Provider
(generator: Any)¶ Bases:
faker.providers.job.Provider
-
job
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.job() ... '감사 사무원' '상/하수도 처리장치 조작원' '메이크업 아티스트 및 분장사' '숙박/여행/오락 및 스포츠 관련 관리자' '상품기획 전문가'
-
faker.providers.person
¶
-
class
faker.providers.person.ko_KR.
Provider
(generator: Any)¶ Bases:
faker.providers.person.Provider
-
first_name
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.first_name() ... '정희' '유진' '지후' '영호' '미경'
-
first_name_female
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.first_name_female() ... '지현' '지연' '영자' '선영' '옥순'
-
first_name_male
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.first_name_male() ... '준혁' '정훈' '승현' '상훈' '영일'
-
first_name_nonbinary
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.first_name_nonbinary() ... '정희' '유진' '지후' '영호' '미경'
-
language_name
() → str¶ Generate a random i18n language name (e.g. English).
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.language_name() ... 'Luba-Katanga' 'Malay' 'Aymara' 'Interlingue' 'Quechua'
-
last_name
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.last_name() ... '홍' '권' '이' '김' '박'
-
last_name_female
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.last_name_female() ... '홍' '권' '이' '김' '박'
-
last_name_male
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.last_name_male() ... '홍' '권' '이' '김' '박'
-
last_name_nonbinary
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.last_name_nonbinary() ... '홍' '권' '이' '김' '박'
-
name
() → str¶ Example: ‘John Doe’ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.name() ... '권영자' '박승민' '이예은' '백예진' '권우진'
-
name_female
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.name_female() ... '권영자' '박영순' '이예은' '백예진' '권은정'
-
name_male
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.name_male() ... '권승현' '박승민' '이영수' '백영일' '권우진'
-
name_nonbinary
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.name_nonbinary() ... '권영자' '박승민' '이예은' '백예진' '권우진'
-
prefix
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.prefix() ... '' '' '' '' ''
-
prefix_female
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.prefix_female() ... '' '' '' '' ''
-
prefix_male
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.prefix_male() ... '' '' '' '' ''
-
prefix_nonbinary
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.prefix_nonbinary() ... '' '' '' '' ''
-
suffix
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.suffix() ... '' '' '' '' ''
-
suffix_female
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.suffix_female() ... '' '' '' '' ''
-
suffix_male
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.suffix_male() ... '' '' '' '' ''
-
suffix_nonbinary
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.suffix_nonbinary() ... '' '' '' '' ''
-
faker.providers.phone_number
¶
-
class
faker.providers.phone_number.ko_KR.
Provider
(generator: Any)¶ Bases:
faker.providers.phone_number.Provider
-
country_calling_code
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.country_calling_code() ... '+687' '+595' '+880' '+964' '+41'
-
msisdn
() → str¶ https://en.wikipedia.org/wiki/MSISDN
Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.msisdn() ... '6048764759382' '2194892411578' '5659387784080' '6097535139332' '1158714841858'
-
phone_number
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.phone_number() ... '055-604-8764' '063-593-8242' '033-948-9241' '070-1578-1565' '016-387-7840'
-
faker.providers.ssn
¶
-
class
faker.providers.ssn.ko_KR.
Provider
(generator: Any)¶ Bases:
faker.providers.ssn.Provider
-
ssn
() → str¶ Examples: >>> Faker.seed(0) >>> for _ in range(5): ... fake.ssn() ... '600408-2764759' '820412-1194892' '110527-1815659' '380727-2840801' '600927-2535139'
-